Webhook for complete payment

GET /api/payments/webhook-sample-payment-complete

Webhook payload description for sample complete

Responses

• 200

---

Sample Webhook response for payment

Response Headers

• x-type any

  Webhook type (payment)

• x-secret-hash any

  Secret hash provided

*/*

Schema

Schema

• connectionId string
• connectionPassword string
• transactionId string
• recipientId string
• detail string
• paymentStatus string

  Possible values: [PENDING, COMPLETE, FAILED, PENDING_AUTHORIZATION, PENDING_MFA, CANCELLED, TOKEN_INVALID, INSUFFICIENT_FUNDS, SUCCESS]

• paymentId uuid
• reference string
• uniqueReference string
• amount double
• amountFee double
• amountTax double
• timestamp string
• transferType string

  Possible values: [BANK, B2B, MOBILE_MONEY, INTERNAL, INTERNAL_FX, BILL_PAYMENT, COUNTERPARTY_TRANSFER]

• currency string
• description string
• globalAccountId string
• runningBalance double
• tags object[]

  Array [

  reference string

  amount double

  tagCode string

  tagName string

  ]
• tagName string
• tagCode string

Example (from schema)

{
  "connectionId": "string",
  "connectionPassword": "string",
  "transactionId": "string",
  "recipientId": "string",
  "detail": "string",
  "paymentStatus": "PENDING",
  "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "uniqueReference": "string",
  "amount": 0,
  "amountFee": 0,
  "amountTax": 0,
  "timestamp": "string",
  "transferType": "BANK",
  "currency": "string",
  "description": "string",
  "globalAccountId": "string",
  "runningBalance": 0,
  "tags": [
    {
      "reference": "string",
      "amount": 0,
      "tagCode": "string",
      "tagName": "string"
    }
  ],
  "tagName": "string",
  "tagCode": "string"
}

Loading...