Webhook Events

This page documents the webhook events specific to international payments. For information on setting up webhooks, see Webhooks.

payment.created

Occurs when an International Payment is successfully created with a specified status. This event does not fire for rejected payments, see payment.rejected instead.

Relationship	Type	Description
payment	JSON:API Relationship	The payment. Resource type: `payment`.
account	JSON:API Relationship	The account the payment relates to. Resource type: `account`.
customer	JSON:API Relationship	Optional. The customer the account belongs to. Resource type: `customer`.

Example payment.created payload:
{
  "data": [
    {
      "id": "1340",
      "type": "payment.created",
      "attributes": {
        "createdAt": "2024-01-15T10:10:00.000Z",
        "status": "Pending",
        "direction": "Credit",
        "amount": 10850,
        "tags": {
          "invoice_id": "INV-2024-0115"
        }
      },
      "relationships": {
        "payment": {
          "data": {
            "id": "400",
            "type": "payment"
          }
        },
        "account": {
          "data": {
            "id": "5000",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "1000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

payment.pendingReview

Occurs when an International Payment requires additional information before it can continue processing.

Relationship	Type	Description
payment	JSON:API Relationship	The payment. Resource type: `payment`.
account	JSON:API Relationship	The account the payment relates to. Resource type: `account`.
customer	JSON:API Relationship	Optional. The customer the account belongs to. Resource type: `customer`.

Example payment.pendingReview payload:
{
  "data": [
    {
      "id": "1341",
      "type": "payment.pendingReview",
      "attributes": {
        "createdAt": "2024-01-15T10:11:00.000Z",
        "direction": "Credit",
        "amount": 10850,
        "tags": {
          "invoice_id": "INV-2024-0115"
        }
      },
      "relationships": {
        "payment": {
          "data": {
            "id": "400",
            "type": "payment"
          }
        },
        "account": {
          "data": {
            "id": "5000",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "1000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

payment.rejected

Occurs when an international payment gets rejected. International payments may be rejected at any stage. This event includes a reason that specifies why the payment was rejected. See Rejections & Returns for more details.

Relationship	Type	Description
payment	JSON:API Relationship	The payment. Resource type: `payment`.
account	JSON:API Relationship	The account the payment relates to. Resource type: `account`.
customer	JSON:API Relationship	Optional. The customer the account belongs to. Resource type: `customer`.

Example payment.rejected payload:
{
  "data": [
    {
      "id": "1342",
      "type": "payment.rejected",
      "attributes": {
        "createdAt": "2024-01-15T10:12:00.000Z",
        "reason": "InsufficientFunds",
        "direction": "Credit",
        "amount": 10850,
        "tags": {
          "invoice_id": "INV-2024-0115"
        }
      },
      "relationships": {
        "payment": {
          "data": {
            "id": "400",
            "type": "payment"
          }
        },
        "account": {
          "data": {
            "id": "5000",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "1000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

payment.sent

Occurs when an International Payment was processed successfully and the funds were sent to the counterparty's bank.

Relationship	Type	Description
payment	JSON:API Relationship	The payment. Resource type: `payment`.
account	JSON:API Relationship	The account the payment relates to. Resource type: `account`.
customer	JSON:API Relationship	Optional. The customer the account belongs to. Resource type: `customer`.

Example payment.sent payload:
{
  "data": [
    {
      "id": "1343",
      "type": "payment.sent",
      "attributes": {
        "previousStatus": "Pending",
        "direction": "Credit",
        "amount": 10850,
        "available": 500,
        "createdAt": "2024-01-15T10:30:00.000Z",
        "tags": {
          "invoice_id": "INV-2024-0115"
        }
      },
      "relationships": {
        "payment": {
          "data": {
            "id": "400",
            "type": "payment"
          }
        },
        "account": {
          "data": {
            "id": "5000",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "1000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

payment.returned

Occurs when a sent International Payment was returned by the counterparty's bank. The return reason is available on the payment's reason attribute. See Rejections & Returns for more details.

Relationship	Type	Description
payment	JSON:API Relationship	The payment. Resource type: `payment`.
account	JSON:API Relationship	The account the payment relates to. Resource type: `account`.
customer	JSON:API Relationship	Optional. The customer the account belongs to. Resource type: `customer`.

Example payment.returned payload:
{
  "data": [
    {
      "id": "1344",
      "type": "payment.returned",
      "attributes": {
        "previousStatus": "Sent",
        "createdAt": "2024-01-17T09:00:00.000Z",
        "direction": "Credit",
        "amount": 10850,
        "available": 11350,
        "tags": {
          "invoice_id": "INV-2024-0115"
        }
      },
      "relationships": {
        "payment": {
          "data": {
            "id": "400",
            "type": "payment"
          }
        },
        "account": {
          "data": {
            "id": "5000",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "1000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

quote.created

Occurs when a Quote is successfully created and enters New status.

Example quote.created payload:
{
  "data": [
    {
      "id": "1338",
      "type": "quote.created",
      "attributes": {
        "createdAt": "2024-01-15T10:05:00.000Z",
        "status": "New",
        "sourceAmount": 10850,
        "sourceCurrency": "USD",
        "destinationAmount": 10000,
        "destinationCurrency": "EUR",
        "exchangeRate": "1.085",
        "expiresAt": "2024-01-15T10:20:00.000Z"
      },
      "relationships": {
        "quote": {
          "data": {
            "id": "300",
            "type": "quote"
          }
        },
        "customer": {
          "data": {
            "id": "1000",
            "type": "businessCustomer"
          }
        },
        "counterparty": {
          "data": {
            "id": "200",
            "type": "swiftCounterparty"
          }
        }
      }
    }
  ]
}

quote.used

Occurs when a quote is consumed by an International Payment and moves to Used status.

Example quote.used payload:
{
  "data": [
    {
      "id": "1339",
      "type": "quote.used",
      "attributes": {
        "createdAt": "2024-01-15T10:10:00.000Z",
        "status": "Used",
        "sourceAmount": 10850,
        "sourceCurrency": "USD",
        "destinationAmount": 10000,
        "destinationCurrency": "EUR",
        "exchangeRate": "1.085"
      },
      "relationships": {
        "quote": {
          "data": {
            "id": "300",
            "type": "quote"
          }
        },
        "payment": {
          "data": {
            "id": "400",
            "type": "internationalPayment"
          }
        },
        "customer": {
          "data": {
            "id": "1000",
            "type": "businessCustomer"
          }
        },
        "counterparty": {
          "data": {
            "id": "200",
            "type": "swiftCounterparty"
          }
        }
      }
    }
  ]
}

transaction.created

Occurs when an international payment-related Transaction is created. For international payments, the transaction type in the relationships will be originatedInternationalTransaction. See International Payment Transaction for details.

Example transaction.created payload:
{
  "data": [
    {
      "id": "1345",
      "type": "transaction.created",
      "attributes": {
        "summary": "International payment to Hans Mueller",
        "direction": "Debit",
        "amount": 10850,
        "available": 500,
        "balance": 500,
        "createdAt": "2024-01-15T10:10:00.000Z",
        "tags": {
          "invoice_id": "INV-2024-0115"
        }
      },
      "relationships": {
        "transaction": {
          "data": {
            "type": "originatedInternationalTransaction",
            "id": "6001"
          }
        },
        "account": {
          "data": {
            "id": "5000",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "1000",
            "type": "customer"
          }
        },
        "payment": {
          "data": {
            "id": "400",
            "type": "internationalPayment"
          }
        }
      }
    }
  ]
}

payment.created​

payment.pendingReview​

payment.rejected​

payment.sent​

payment.returned​

quote.created​

quote.used​

transaction.created​