StatusLog In
API Reference and Guides

Sections

Theme switcher

/payments/{paymentTransactionId}

Header Parameters

Authorizationstring

Query Parameters

paymentTypestring

The type of the payment.

Enum values:
payouttransfer
payoutTypestring

The type of the payment.

Enum values:
swiftlocal

Path Parameters

paymentTransactionIdstring Required
Min length
38
Max length
100
Pattern
[a-zA-Z]{1,63}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Response

200
Object
Successful response.

Response Attributes

OneOf 

paymentTransactionIdstring

The Id of the payment transaction.

Min length
38
Max length
100
Pattern
paymentTransaction_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
readOnly
paymentReasonstring

The reason defined for the payment. Valid values for this field are any reasonCode property from the GET /payment/reasonCodes endpoint.

referencestring

The reference which will show on the recipients bank records.

Min length
1
Max length
18
paymentTypestring

The rails the payment has been executed upon based upon the recipient payment address.

Enum values:
payouttransfer
readOnly
currencystring

The currency the payment is being made in.

Min length
3
Max length
3
amountnumber

The amount of the payment.

fromWalletIdstring

The ID of the wallet where the payment is being sent from.

Min length
38
Max length
100
Pattern
wallet_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
recipientIdstring

The recipient of the payment.

Min length
38
Max length
100
Pattern
recipient_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
paymentAddressIdstring

The ID of the payment address.

Min length
38
Max length
100
Pattern
paymentAddress_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
failureReasonstring

If the payment has failed, this field will contain the reason for the rejection. If the payment has not failed, this field will be empty.

readOnly
statusstring

The status of the payment transaction.

Enum values:
submittedprocessingpending_trade_settlementawaiting_fundsreturnedpending_releasereleasedsettledrejected
readOnly
createdAtstring

The UTC datetime for when the payment was created.

Min length
20
Max length
20
readOnly
updatedAtstring

The UTC datetime for when the payment was last updated.

Min length
20
Max length
20
readOnly
paymentDatestring

The date the payment will be released to the recipient.

readOnly
externalReferencestring

An optional value that can be passed in to later reference a related resource in the partner system.

endToEndIdstring

Back-office reference ID for bank tracking of the end-to-end payment. Only available when a payment reaches released status.

payoutTypestring

Type of payout to be made. Please ensure you cross reference which routing details you are supplying with the payment type to avoid any payment failures.

Enum values:
swiftlocal
400
Object
Bad Request

Response Attributes

messagestring Required
errorsarray Required

Show child attributes

401
Object
Unauthorized

Response Attributes

messagestring
errorsarray Required

Show child attributes

500
Object
Unknown Error

Response Attributes

messagestring
errorsarray Required

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?