Payout status updates

Understand the different ways to get the status of a payout

The time it takes a bank to process a payout request can vary and may not be instant. Because of this, Vyne provides updates when a payout status changes.

There are different methods to obtain the status of the payout.

Method

Description

Use case

Webhook notifications

Webhook notification of a status change on the payout.

Be notified as soon as the payout status changes.

Get payouts

Get the status of the payout manually.

If a manual update is required on demand, merchants can get the status of the payout at any time.

Using webhook notifications

When the status of a payout is updated, Vyne will send a digitally signed POST request to the specified callback URL. Make sure you have set up a callback URL.

Find out more about payout statuses here.

Webhook

{
  "type": "PAYOUT_STATUS_CHANGE",
  "payoutId": "4c0baba6eb85b05c",
  "status": "FAILED",
  "timestamp": 1632739441182,
  "amount": 10,
  "currency": "GBP"
}

Parameter

Description

type

A constant type for the payout status notification.

payoutId

16 digit alphanumeric unique payout identifier.

status

The status of the payout. For all possible statuses see here.

timestamp

Exact date when the webhook notification was sent represented by a UNIX epoch time in milliseconds.

amount

The amount of the payout.

currency

The three-character currency using ISO 4217.

Verifying integrity

Every webhook notification sent by Vyne is digitally signed using public key cryptography, also known as asymmetric cryptography, and will allow the merchant verify the origin and the integrity of the message. Learn how to verify the integrity of the webhook notification here.

Using payout status call

You can request the status of on any payout at any time by sending an HTTP GET request to the relevant base URL + /api/v1/payouts/{payoutId} including the headers Authorization: Bearer <payment_token>. Generate a fresh payment token for the <payment_token>.

Request

curl --location --request GET 'https://uat.app.payvyne.com/api/v1/payouts/520f6dec2b1f6dc8' \
--header 'Authorization: Bearer <payment_token>'\
--header 'Content-Type: application/json'

Parameter

Description

payoutId

The unique identifier of the payout generated

A successful request returns a 200 response code and an object with details of the payout.

If something unexpected happened during the request, the API returns an error response with the appropriate HTTP status code and a JSON response that contains detailed information about the problem.

Response

{
  "payoutId": "4c0baba6eb85b05c",
  "status": "FAILED",
  "amount": 10,
  "currency": "GBP"
}

Parameter

Description

payoutId

16 digit alphanumeric unique payout identifier.

status

The status of the payout. For all possible statuses see here.

amount

The amount of the payout.

currency

The three-character currency using ISO 4217.


Did this page help you?