Get Payment
curl --request GET \
--url https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "payment",
"id": "apo_5tg9m9p4q1w8e5r3t6y0u2i4",
"type": "payment",
"amount": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"currency": "USD",
"status": "pending_review",
"submitted_at": "2026-05-30T09:00:00Z",
"reviewed_at": null,
"settled_at": null,
"failed_at": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"payment": {
"submitted_at": "2026-05-30T09:00:00Z",
"method": "wire",
"amount_sent": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"currency": "USD",
"note": null,
"reference": "Invoice 42",
"payment_purpose": "supplier_or_vendor_payment",
"bank_reference": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"request_id": "d6f1c9e0-7a2b-4f3c-9b8d-2e5a1c7f9d04"
},
"beneficiary": {
"beneficiary_id": "bene_2aq7c1e6a2b4f3c9b8d2e5a1",
"beneficiary_name": "Globex Ltd",
"payment_destination_id": "dest_9kp7c1e6a2b4f3c9b8d2e5a1",
"account": "USD ....7823",
"beneficiary_type": "business",
"destination_bank": "Chase",
"destination_bank_address": null,
"destination_account_name": "Globex Ltd",
"destination_country": "US",
"destination_account_number": "****7823",
"destination_swift": "CHASUS33",
"correspondent_bank_name": null,
"correspondent_bank_address": null,
"correspondent_bank_swift": null
}
}
Payments
Get Payment
Fetch a single payment with its payment and beneficiary detail blocks
GET
/
ads
/
v1
/
accounts
/
{account_id}
/
payments
/
{payment_id}
Get Payment
curl --request GET \
--url https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/payments/{payment_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "payment",
"id": "apo_5tg9m9p4q1w8e5r3t6y0u2i4",
"type": "payment",
"amount": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"currency": "USD",
"status": "pending_review",
"submitted_at": "2026-05-30T09:00:00Z",
"reviewed_at": null,
"settled_at": null,
"failed_at": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"payment": {
"submitted_at": "2026-05-30T09:00:00Z",
"method": "wire",
"amount_sent": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"currency": "USD",
"note": null,
"reference": "Invoice 42",
"payment_purpose": "supplier_or_vendor_payment",
"bank_reference": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"request_id": "d6f1c9e0-7a2b-4f3c-9b8d-2e5a1c7f9d04"
},
"beneficiary": {
"beneficiary_id": "bene_2aq7c1e6a2b4f3c9b8d2e5a1",
"beneficiary_name": "Globex Ltd",
"payment_destination_id": "dest_9kp7c1e6a2b4f3c9b8d2e5a1",
"account": "USD ....7823",
"beneficiary_type": "business",
"destination_bank": "Chase",
"destination_bank_address": null,
"destination_account_name": "Globex Ltd",
"destination_country": "US",
"destination_account_number": "****7823",
"destination_swift": "CHASUS33",
"correspondent_bank_name": null,
"correspondent_bank_address": null,
"correspondent_bank_swift": null
}
}
Fetches a single payment with its client-facing
payment and beneficiary detail blocks. A payment id that does not exist within the authorized account returns 404; an account id owned by another organization returns 403.
Path Parameters
string
required
Id of the account (
acct_…).string
required
Id of the payment (
apo_…).Response
string
Payment id.
object is payment, type is payment.decimal
Recipient amount in the destination currency.
decimal
Add-on platform fee (default 0).
decimal
amount + platform_fee_amount — the total debited from the source virtual account.object | null
enum
Payment currency.
enum
PaymentStatus: pending_review, pending, processing, settled, failed, rejected, returned.datetime
When the payment order was created.
datetime | null
Lifecycle timestamps for review, settlement, and failure.
datetime | null
Scheduling timestamps: the requested dispatch time and when the scheduled payment was actually dispatched.
object
Payment details.
Show child attributes
Show child attributes
datetime
When the payment order was created.
enum
PaymentMethod: wire, ach, fedwire, spei, pix, manual.decimal
Amount sent to the beneficiary.
decimal
Platform fee on this payment.
decimal
Total debit (
amount_sent + platform_fee_amount).object | null
Same receipt breakdown as the top-level
receipt.enum
Payment currency.
string | null
Private note for your platform, from create.
string | null
Bank-visible memo (SWIFT MT103 Field 70).
enum | null
PaymentPurpose value from create.string | null
Bank or payment-network reference, populated once the payment is in flight.
datetime | null
Requested dispatch time, if scheduled.
datetime | null
When the scheduled payment was dispatched.
string
Request identifier associated with the payment submission.
object
Beneficiary and destination details.
Show child attributes
Show child attributes
string
Beneficiary id (
bene_…).string
Beneficiary display name.
string
Payment destination id (
dest_…).string
Masked destination account label, e.g.
USD ....7823.string | null
Beneficiary type.
string | null
Destination bank name.
object | null
Destination bank address — an Address object (
address_line, city, region, postal_code, country).string | null
Name on the destination account.
string | null
ISO 3166-1 alpha-2 destination country code.
string | null
Destination account number.
string | null
Destination bank SWIFT/BIC.
string | null
Correspondent bank name, when applicable.
object | null
Correspondent bank address — an Address object (
address_line, city, region, postal_code, country).string | null
Correspondent bank SWIFT/BIC.
{
"object": "payment",
"id": "apo_5tg9m9p4q1w8e5r3t6y0u2i4",
"type": "payment",
"amount": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"currency": "USD",
"status": "pending_review",
"submitted_at": "2026-05-30T09:00:00Z",
"reviewed_at": null,
"settled_at": null,
"failed_at": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"payment": {
"submitted_at": "2026-05-30T09:00:00Z",
"method": "wire",
"amount_sent": "1000.00",
"platform_fee_amount": "25.00",
"total_debit_amount": "1025.00",
"receipt": {
"recipient_amount": "1000.00",
"platform_fee": "25.00",
"total_debit": "1025.00"
},
"currency": "USD",
"note": null,
"reference": "Invoice 42",
"payment_purpose": "supplier_or_vendor_payment",
"bank_reference": null,
"transfer_at": null,
"scheduled_dispatched_at": null,
"request_id": "d6f1c9e0-7a2b-4f3c-9b8d-2e5a1c7f9d04"
},
"beneficiary": {
"beneficiary_id": "bene_2aq7c1e6a2b4f3c9b8d2e5a1",
"beneficiary_name": "Globex Ltd",
"payment_destination_id": "dest_9kp7c1e6a2b4f3c9b8d2e5a1",
"account": "USD ....7823",
"beneficiary_type": "business",
"destination_bank": "Chase",
"destination_bank_address": null,
"destination_account_name": "Globex Ltd",
"destination_country": "US",
"destination_account_number": "****7823",
"destination_swift": "CHASUS33",
"correspondent_bank_name": null,
"correspondent_bank_address": null,
"correspondent_bank_swift": null
}
}
⌘I