---
updatedAt: 2025-09-17T23:33:05.000Z
agentTools:
projectIndex: https://docs.nexiopay.com/llms.txt
---
# Submit payouts
Allows you to submit one or more payouts in the body of an API request.
Payouts can be made to existing recipients or you can create a recipient at the same time as submitting a payout by including the amount and currency for the payout as well as the required parameters for a recipient.
### Required payout parameters
The required parameters for a payout are the following:
- `amount`
- `currency`
- The **required recipient parameters**
### Required recipient parameters
For sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
- `recipientRef`
- `recipientId`
- `email`
**Note:** The system ignores any other recipient parameters that you include.
For sending a payout to a **new recipient**, you must include at least the following recipient parameters:
- `recipientRef`
- `email`
- `firstName`
- `lastName`
- `country`
You may also optionally include any of the other parameters for [creating a recipient](ref:createrecipient).
> 📘 Note
>
> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with [Update recipient](ref:updaterecipient) endpoint.
> ⚠️ Try It
>
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments).
Include all the required parameters for a payout and a recipient, depending on whether this is for a new or existing recipient (see above).
## Request parameters
- payouts
- payouts.amount
- payouts.currency
- payouts.recipient
- payouts.recipient.recipientRef
- payouts.recipient.recipientId
- payouts.recipient.email
- payouts.recipient.firstName
- payouts.recipient.lastName
- payouts.recipient.country
- payouts.recipient.providerId
- payouts.recipient.userType
- payouts.recipient.gender
- payouts.recipient.birthDate
- payouts.recipient.countryOfBirth
- payouts.recipient.countryOfNationality
- payouts.recipient.currency
- payouts.recipient.addressType
- payouts.recipient.addressLine1
- payouts.recipient.addressLine2
- payouts.recipient.city
- payouts.recipient.region
- payouts.recipient.postalCode
- payouts.recipient.phoneNumber
- payouts.recipient.phoneNumberCountry
- payouts.recipient.mobileNumber
- payouts.recipient.mobileNumberCountry
- payouts.recipient.governmentIdType
- payouts.recipient.recipientIdNumbers
- payouts.recipient.recipientIdNumbers.governmentId
- payouts.recipient.recipientIdNumbers.passportId
- payouts.recipient.recipientIdNumbers.employerId
- payouts.recipient.recipientIdNumbers.driversLicenseId
- payouts.description
- payouts.payoutRef
- batchRef
## Response parameters
- message
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Payouts API Reference",
"version": "3.0.0",
"description": "![\"Payout\"](\"https://files.readme.io/2d0a9c3-payout_icon.png\")
Use the Payouts API to push payments to recipients. These endpoints allow you to create and view recipients, send and view payouts, and send multiple payouts through a batch file. For additonal information, see [Payouts](https://docs.nexiopay.com/docs/payouts-overview) in Guides.",
"contact": {
"name": "Integrations Support",
"email": "integrations@nexiopay.com",
"url": "https://nexiointegrations.slack.com/"
},
"license": {
"name": "ISC",
"url": "https://docs.nexiopay.com/page/license"
}
},
"security": [
{
"Basic_Authentication": []
},
{
"One-time-use_Token": []
}
],
"servers": [
{
"description": "Sandbox",
"url": "https://api.nexiopaysandbox.com",
"variables": {}
}
],
"components": {
"securitySchemes": {
"Basic_Authentication": {
"type": "http",
"scheme": "basic",
"description": "Basic authentication is a simple authentication scheme built into the HTTP protocol. \n\nFor the \"Try It\" feature, type your API username and password in the appropriate fields. The system then automatically creates the Authorization header that contains the word `Basic` followed by a space and a base64-encoded string `username:password`. \n\nFor example: `Authorization: Basic ZGVtbzpwQDU1dzByZA==` \n\nFor your own requests, learn how to do the conversion in the [Authentication](https://docs.nexiopay.com/docs/authentication#basic-authentication) guide. \n\nFor more information about this security protocol, see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample"
},
"One-time-use_Token": {
"type": "apiKey",
"name": "token",
"in": "query",
"description": "The one-time-use token authentication scheme requires a token supplied in the named query parameter that can only be used to submit a single API request and that expires after one hour. \n\nFor the \"Try It\" feature, first generate the one-time-use token through either the [Create one-time-use token](https://docs.nexiopay.com/reference/createonetimeusetoken) or the [Create APM one-time-use token](https://docs.nexiopay.com/reference/createapmonetimeusetoken) endpoint. Copy the resulting token and then paste it in the appropriate field for the current endpoint. \n\nFor your own requests, learn how to generate the one-time-use token in the [Authentication](https://docs.nexiopay.com/docs/authentication#one-time-use-tokens) guide. Then, use it as normal for this endpoint. \n\nFor more information about the \"apiKeys\" security protocol, see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object"
}
},
"responses": {
"401": {
"description": "Unauthorized.\n\nFor help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A message from Nexio about the state of the request.",
"example": "Unauthorized"
}
}
}
}
}
}
}
},
"tags": [
{
"name": "Recipients",
"description": "APIs for payout recipients"
},
{
"name": "Payouts",
"description": "APIs for payouts"
},
{
"name": "Spendbacks",
"description": "APIs for spendbacks"
}
],
"paths": {
"/payout/v3/recipient": {
"post": {
"summary": "Create a recipient",
"operationId": "CreateRecipient",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"title": "recipient",
"type": "object",
"x-tags": [
"object"
],
"description": "Contains the set of recipient parameters.",
"properties": {
"recipientRef": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/recipientRef"
},
"recipientId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/recipientId"
},
"payoutAccountId": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/payoutAccountId"
},
"providerId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/providerId"
},
"providerType": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/providerType"
},
"providerRecipientRef": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/providerRecipientRef"
},
"userType": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/userType"
},
"firstName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/firstName"
},
"lastName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/lastName"
},
"gender": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/gender"
},
"birthDate": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/birthDate"
},
"countryOfBirth": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfBirth"
},
"countryOfNationality": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfNationality"
},
"addressLine1": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine1"
},
"addressLine2": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine2"
},
"city": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/city"
},
"region": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/region"
},
"postalCode": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/postalCode"
},
"country": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/country"
},
"email": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/email"
},
"phoneNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/phoneNumber"
},
"mobileNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/mobileNumber"
},
"governmentIdType": {
"$ref": "#/paths/~1payout~1v3~1recipient/post/requestBody/content/application~1json/schema/properties/governmentIdType"
},
"recipientIdNumbers": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/recipientIdNumbers"
},
"createdAt": {
"type": "string",
"title": "createdAt",
"description": "The date and time the recipient record was created in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.",
"example": "2019-02-21T05:39:59.000Z",
"x-tags": [
"component"
]
},
"updatedAt": {
"type": "string",
"title": "updatedAt",
"description": "The date and time the recipient record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.",
"example": "2019-02-23T05:39:59.000Z",
"x-tags": [
"component"
]
}
}
},
"examples": {
"Minimum response": {
"value": {
"providerId": 12610,
"email": "jdoe@example.com",
"firstName": "John",
"lastName": "Doe",
"recipientId": 137241,
"providerRecipientRef": "REoHUEeHcKRRaDoAQFwvzGIA",
"payoutAccountId": 3927,
"providerType": 10,
"recipientIdNumbers": {},
"updatedAt": "2021-11-22T17:19:19.893Z",
"createdAt": "2021-11-22T17:19:19.893Z"
}
},
"All parameters response": {
"value": {
"recipientId": 137292,
"email": "jdoe@example.com",
"firstName": "John",
"lastName": "Doe",
"providerId": 12610,
"providerType": 10,
"recipientRef": "[your_recipient_id]",
"providerRecipientRef": "RELjJAmW4iRSOu-pdHaoawxQ==",
"payoutAccountId": 3927,
"userType": "INDIVIDUAL",
"birthDate": "1990-12-05",
"countryOfBirth": "US",
"countryOfNationality": "US",
"gender": "MALE",
"addressType": "RESIDENTIAL",
"addressLine1": "2147 West Silverlake Drive",
"addressLine2": "Apt 42",
"city": "Scranton",
"region": "PA",
"postalCode": "18503",
"country": "US",
"phoneNumber": "1555555555",
"phoneNumberCountry": "US",
"mobileNumber": "18011234567",
"mobileNumberCountry": "US",
"governmentIdType": "SSN",
"recipientIdNumbers": {
"governmentId": "...7891",
"passportId": "...1232",
"driversLicenseId": "...1113",
"employerId": "...3579"
},
"updatedAt": "2021-11-22T17:18:19.200Z",
"createdAt": "2021-11-22T17:18:19.200Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401"
}
},
"description": "Creates a recipient profile to which payments can be sent. A recipient is the individual or business receiving payments. Before paying out to a recipient, you must first create a recipient profile, either as a separate process or at the same time as the [payout request](https://docs.nexiopay.com/reference/submitpayouts).\n\n\n> 📘 Note \n> \n> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with [Update recipient](https://docs.nexiopay.com/reference/updaterecipient) endpoint.\n\n\n> ⚠️ Try It\n>\n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).
Include at least a `recipientRef`, recipient `email`, recipient `firstName` and `lastName`, and the `country` for the recipient.\n\n\n\n## Request parameters\n- recipientRef\n- email\n- firstName\n- lastName\n- country\n- providerId\n- userType\n- gender\n- birthDate\n- countryOfBirth\n- countryOfNationality\n- currency\n- addressType\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- phoneNumber\n- phoneNumberCountry\n- mobileNumber\n- mobileNumberCountry\n- governmentIdType\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n\n## Response parameters\n- recipientRef\n- recipientId\n- payoutAccountId\n- providerId\n- providerType\n- providerRecipientRef\n- userType\n- firstName\n- lastName\n- gender\n- birthDate\n- countryOfBirth\n- countryOfNationality\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- country\n- email\n- phoneNumber\n- mobileNumber\n- governmentIdType\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- createdAt\n- updatedAt\n\n
",
"requestBody": {
"content": {
"application/json": {
"schema": {
"description": "",
"type": "object",
"properties": {
"recipientRef": {
"type": "string",
"title": "recipientRef",
"description": "Your unique identifier for a recipient. This allows for easier synchronization across different systems. \n\n \n> #### Important \n> We strongly recommend that you include this value in your request in order to facilitate payment reconciliation. \n",
"example": "[your_recipient_id]",
"x-tags": [
"component"
],
"maxLength": 100
},
"email": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/email"
},
"firstName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/firstName"
},
"lastName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/lastName"
},
"country": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/country"
},
"providerId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/providerId"
},
"userType": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/userType"
},
"gender": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/gender"
},
"birthDate": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/birthDate"
},
"countryOfBirth": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfBirth"
},
"countryOfNationality": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfNationality"
},
"currency": {
"type": "string",
"title": "currency",
"description": "\nThe [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for payouts to the specified recipient.\n\n\n> #### Note\n> We pass this value through to the payout provider, but we do not save or return it in the response.",
"example": "USD",
"x-tags": [
"component"
],
"maxLength": 3
},
"addressType": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressType"
},
"addressLine1": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine1"
},
"addressLine2": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine2"
},
"city": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/city"
},
"region": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/region"
},
"postalCode": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/postalCode"
},
"phoneNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/phoneNumber"
},
"phoneNumberCountry": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/phoneNumberCountry"
},
"mobileNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/mobileNumber"
},
"mobileNumberCountry": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/mobileNumberCountry"
},
"governmentIdType": {
"type": "string",
"title": "governmentIdType",
"x-tags": [
"component"
],
"description": "Type of the government ID provided for the recipient.\n\n\n\n\nThe ID indicated by this value corresponds to the ID provided in the `recipientIdNumbers.governmentId` parameter.",
"example": "SSN"
},
"recipientIdNumbers": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/recipientIdNumbers"
}
},
"required": [
"recipientRef",
"email",
"firstName",
"lastName",
"country"
]
},
"examples": {
"Required parameters": {
"value": {
"recipientRef": "[your_recipient_id]",
"email": "jdoe@example.com",
"firstName": "John",
"lastName": "Doe",
"country": "US"
}
},
"All parameters": {
"value": {
"currency": "USD",
"email": "jdoe@example.com",
"firstName": "John",
"lastName": "Doe",
"providerId": 12610,
"recipientRef": "[your_recipient_id]",
"userType": "INDIVIDUAL",
"birthDate": "1990-12-05",
"countryOfBirth": "US",
"countryOfNationality": "US",
"gender": "MALE",
"addressType": "RESIDENTIAL",
"addressLine1": "2147 West Silverlake Drive",
"addressLine2": "Apt 42",
"city": "Scranton",
"region": "PA",
"postalCode": "18503",
"country": "US",
"phoneNumber": "1555555555",
"phoneNumberCountry": "US",
"mobileNumber": "18011234567",
"mobileNumberCountry": "US",
"governmentIdType": "SSN",
"recipientIdNumbers": {
"governmentId": "1234567891",
"passportId": "4561231232",
"driversLicenseId": "7890111113",
"employerId": "2468013579"
}
}
}
}
}
},
"description": ""
},
"security": [
{
"Basic_Authentication": []
}
],
"tags": [
"Recipients"
]
},
"put": {
"summary": "Update recipient",
"operationId": "UpdateRecipient",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"payoutAccountId": {
"type": "string",
"title": "payoutAccountId",
"description": "The Nexio ID for the payout account associated with the webhooks. This parameter is only returned when the request included the `payoutAccountId` parameter.\n\nEither this parameter or `merchantId` is returned.",
"example": "3927",
"x-tags": [
"component"
]
},
"providerId": {
"type": "integer",
"title": "providerId",
"description": "The Nexio ID for the provider. Indicates the payout provider associated with this recipient profile.",
"x-tags": [
"component"
],
"example": "12610"
},
"recipientId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/recipientId"
},
"recipientRef": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/recipientRef"
},
"email": {
"type": "string",
"title": "email",
"description": "The recipient's email address.",
"example": "jdoe@example.com",
"x-tags": [
"component"
],
"maxLength": 200
},
"firstName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/firstName"
},
"lastName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/lastName"
},
"providerType": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/providerType"
},
"providerRecipientRef": {
"type": "string",
"title": "providerRecipientRef",
"description": "Reference value for the payout from the payout provider. This allows for easier synchronization and searching across different systems.",
"x-tags": [
"component"
],
"example": "spnd_bk_519cbf18-b432-11ec-a6df-06bb2a295f6f",
"maxLength": 100
},
"userType": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/userType"
},
"addressLine1": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine1"
},
"addressLine2": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine2"
},
"city": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/city"
},
"region": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/region"
},
"postalCode": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/postalCode"
},
"country": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/country"
},
"phoneNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/phoneNumber"
},
"mobileNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/mobileNumber"
},
"countryOfBirth": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfBirth"
},
"countryOfNationality": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfNationality"
},
"gender": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/gender"
},
"birthDate": {
"type": "string",
"title": "birthDate",
"description": "The recipient's date of birth, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date.\n",
"example": "1990-12-05",
"x-tags": [
"component"
],
"x-internal": false
},
"recipientRulesMetadata": {
"type": "object",
"title": "recipientRulesMetaData",
"description": "A list of additional recipient information.",
"example": "US",
"properties": {
"id": {
"type": "integer",
"title": "id",
"description": "A unique ID generated by Nexio when rules are being applied to a recipient. ",
"example": 68,
"x-tags": [
"component"
]
},
"recipientId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/recipientId"
},
"metadata": {
"type": "string",
"title": "metadata",
"x-tags": [
"component"
],
"description": "A list of rules that are applied to a recipient account based on their account information.",
"example": "[{\\\"type\\\":\\\"SPECIFIED\\\",\\\"params\\\":{\\\"providerId\\\":12632}},{\\\"type\\\":\\\"us to interchecks\\\",\\\"params\\\":{\\\"providerId\\\":12632}}]"
},
"createdAt": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/createdAt"
},
"updatedAt": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/updatedAt"
}
},
"x-tags": [
"object"
]
},
"recipientIdNumbers": {
"title": "recipientIdNumbers",
"type": "object",
"x-tags": [
"object"
],
"description": "Contains any specified IDs for the recipient.",
"properties": {
"driversLicenseId": {
"type": "string",
"title": "driversLicenseId",
"example": "...1113",
"description": "The masked driver's license number for the recipient. This value cannot be updated once the recipient has been verified in the payment provider’s system.",
"x-tags": [
"component"
],
"maxLength": 50
},
"employerId": {
"type": "string",
"title": "employerId",
"x-tags": [
"component"
],
"description": "The masked employer ID for the recipient. This is generally used for tax purposes.",
"example": "...3579"
},
"governmentId": {
"type": "string",
"title": "governmentId",
"description": "The masked government ID for the recipient. See the `governmentIdType` parameter for the type of government ID specified here. This value cannot be updated once the recipient has been verified in the payment provider’s system. ",
"example": "...7891",
"x-tags": [
"component"
]
},
"passportId": {
"type": "string",
"title": "passportId",
"description": "The masked passport ID for the recipient. This value cannot be updated once the recipient has been verified in the payment provider’s system.",
"example": "...1232",
"x-tags": [
"component"
]
}
}
},
"createdAt": {
"type": "string",
"title": "createdAt",
"description": "The date and time the payout request was sent to the provider, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.",
"example": "2019-02-21T05:39:59.000Z",
"x-tags": [
"component"
]
},
"updatedAt": {
"type": "string",
"title": "updatedAt",
"description": "The date and time the payout record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.",
"example": "2019-02-23T05:39:59.000Z",
"x-tags": [
"component"
]
}
}
},
"examples": {
"Example response": {
"value": {
"payoutAccountId": "3927",
"providerId": "12610",
"recipientId": 137256,
"recipientRef": "[your_recipient_id]",
"email": "jdoe@example.com",
"firstName": "John",
"lastName": "Doe",
"providerType": 10,
"providerRecipientRef": "spnd_bk_519cbf18-b432-11ec-a6df-06bb2a295f6f",
"userType": "INDIVIDUAL",
"addressLine1": "2147 West Silverlake Drive",
"addressLine2": "Apt 42",
"city": "Scranton",
"region": "PA",
"postalCode": "18503",
"country": "US",
"phoneNumber": "1555555555",
"mobileNumber": "1555555555",
"countryOfBirth": "US",
"countryOfNationality": "US",
"gender": "MALE",
"birthDate": "1990-12-05",
"recipientRulesMetadata": "US",
"recipientIdNumbers": {
"driversLicenseId": "...1113",
"employerId": "...3579",
"governmentId": "...7891",
"passportId": "...1232"
},
"createdAt": "2019-02-21T05:39:59.000Z",
"updatedAt": "2019-02-23T05:39:59.000Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401"
}
},
"description": "This endpoint is used to update information for an existing payout recipient.\n\n\n> 🛑 Important\n> \n> You can only update a recipient record if the request is accepted by the payout provider associated with the `recipientId`.\n\n\n> 📘 Note \n> \n> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with this endpoint.
In the case that a value has been passed for the `recipientIdNumbers` and you are wanting to change information for an existing Interchecks recipient, contact Interchecks to update the recipient's information.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).
Include at least a `recipienId` and recipient `firstName` and `lastName`.\n\n\n\n\n## Request parameters\n- recipientId\n- firstName\n- lastName\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- providerId\n- recipientRef\n- email\n- userType\n- gender\n- birthDate\n- countryOfBirth\n- countryOfNationality\n- country\n- currency\n- addressType\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- phoneNumber\n- phoneNumberCountry\n- mobileNumber\n- mobileNumberCountry\n\n## Response parameters\n- payoutAccountId\n- providerId\n- recipientId\n- recipientRef\n- email\n- firstName\n- lastName\n- providerType\n- providerRecipientRef\n- userType\n- addressLine1\n- addressLine2\n- city\n- region\n- postalCode\n- country\n- phoneNumber\n- mobileNumber\n- countryOfBirth\n- countryOfNationality\n- gender\n- birthDate\n- recipientRulesMetadata\n- recipientRulesMetadata.id\n- recipientRulesMetadata.recipientId\n- recipientRulesMetadata.metadata\n- recipientRulesMetadata.createdAt\n- recipientRulesMetadata.updatedAt\n- recipientIdNumbers\n- recipientIdNumbers.governmentId\n- recipientIdNumbers.passportId\n- recipientIdNumbers.employerId\n- recipientIdNumbers.driversLicenseId\n- createdAt\n- updatedAt\n\n
",
"security": [
{
"Basic_Authentication": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipientId": {
"type": "integer",
"title": "recipientId",
"description": "The Nexio ID for the recipient.",
"example": 137256,
"x-tags": [
"component"
]
},
"firstName": {
"type": "string",
"title": "firstName",
"description": "The recipient's first name. For testing purposes with the Mock Payout account, you can trigger a timeout error by sending `firstName` with a value of `timeout`. You can trigger a server error by sending `firstName` with a value of `server` (along with the appropriate value for `lastName`).",
"example": "John",
"x-tags": [
"component"
],
"maxLength": 200
},
"lastName": {
"type": "string",
"title": "lastName",
"description": "The recipient's last name. For testing purposes with the Mock Payout account, you can trigger a server error by sending `lastName` with a value of `error` (along with the appropriate value for `firstName`).",
"example": "Doe",
"x-tags": [
"component"
],
"maxLength": 200
},
"recipientIdNumbers": {
"title": "recipientIdNumbers",
"type": "object",
"x-tags": [
"object"
],
"description": "Contains any specified IDs for the recipient.",
"properties": {
"governmentId": {
"type": "string",
"title": "governmentId",
"description": "The recipient's government ID. This value corresponds to the selection for the `governmentIdType` parameter.",
"example": "1234567891",
"x-tags": [
"component"
],
"maxLength": 50
},
"passportId": {
"type": "string",
"title": "passportId",
"description": "The recipient's passport ID.",
"example": "4561231232",
"x-tags": [
"component"
],
"maxLength": 50
},
"driversLicenseId": {
"type": "string",
"title": "driversLicenseId",
"description": "The recipient's driver's license number. This value cannot be updated once the recipient has been verified in the payment provider’s system.",
"x-tags": [
"component"
],
"maxLength": 50
},
"employerId": {
"type": "string",
"title": "employerId",
"x-tags": [
"component"
],
"description": "The recipient's employer ID. This is generally used for tax purposes.",
"example": "2468013579",
"maxLength": 50
}
}
},
"providerId": {
"type": "integer",
"title": "providerId",
"description": "The Nexio ID for the provider. Indicates which payout provider to associate with this recipient profile. If no providerId is specified in the request, the system uses the first listed payout provider for the merchant account. \n\nFor information about the possible providers and provider IDs for your account, contact [Integrations Support](https://docs.nexiopay.com/page/contact-us).",
"x-tags": [
"component"
],
"example": "12610"
},
"recipientRef": {
"type": "string",
"title": "recipientRef",
"description": "Payer's unique reference value for the recipient. This allows for easier synchronization and searching across different systems.",
"example": "[your_recipient_id]",
"x-tags": [
"component"
],
"maxLength": 100
},
"email": {
"type": "string",
"title": "email",
"description": "The recipient's email address. This must be unique to the specified payout provider (where the provider is indicated in the `providerId` parameter).",
"example": "jdoe@example.com",
"x-tags": [
"component"
],
"maxLength": 200
},
"userType": {
"type": "string",
"title": "userType",
"description": "The user type associated with the recipient. \n",
"x-tags": [
"component"
],
"example": "INDIVIDUAL",
"enum": [
"BUSINESS",
"INDIVIDUAL"
]
},
"gender": {
"type": "string",
"title": "gender",
"description": "The recipient's gender.\n",
"x-tags": [
"component"
],
"x-internal": false,
"example": "MALE",
"enum": [
"FEMALE",
"MALE"
]
},
"birthDate": {
"type": "string",
"title": "birthDate",
"description": "The recipient's date of birth.\n\nUse any of the following formats for the date:\n- Four-digit year and two-digit month and day, separated with hyphens: YYYY-MM-DD.
For example, 2001-08-26\n- [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
For example, 2001-08-26T13:35:00Z\n- UNIX date (as an integer representing seconds).
For example, 998854500\n",
"example": "1990-12-05",
"x-tags": [
"component"
]
},
"countryOfBirth": {
"type": "string",
"title": "countryOfBirth",
"description": "The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the country where the recipient was born.",
"example": "US",
"x-tags": [
"component"
],
"maxLength": 50
},
"countryOfNationality": {
"type": "string",
"title": "countryOfNationality",
"example": "US",
"description": "The [two-character (Alpha-2) ISO code](https://www.iso.org/obp/ui/#search/code/) for the recipient's country of citizenship or nationality.",
"x-tags": [
"component"
],
"maxLength": 50
},
"country": {
"type": "string",
"title": "country",
"description": "The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the recipient's address.",
"example": "US",
"x-tags": [
"component"
],
"maxLength": 2
},
"currency": {
"type": "string",
"title": "currency",
"description": "The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the payout to the specified recipient.",
"example": "USD",
"x-tags": [
"component"
],
"maxLength": 3
},
"addressType": {
"type": "string",
"title": "addressType",
"description": "The type of address associated with this recipient for the specified address information. \n",
"x-tags": [
"component"
],
"example": "RESIDENTIAL",
"enum": [
"BUSINESS",
"RESIDENTIAL"
]
},
"addressLine1": {
"type": "string",
"title": "addressLine1",
"example": "2147 West Silverlake Drive",
"x-tags": [
"component"
],
"description": "The recipient's street address.",
"maxLength": 200
},
"addressLine2": {
"type": "string",
"title": "addressLine2",
"description": "Additional information about the recipient's street address.",
"example": "Apt 42",
"x-tags": [
"component"
],
"maxLength": 200
},
"city": {
"type": "string",
"title": "city",
"example": "Scranton",
"x-tags": [
"component"
],
"description": "The recipient's city.",
"maxLength": 50
},
"region": {
"type": "string",
"title": "region",
"description": "The recipient's state, province, or region.",
"example": "PA",
"x-tags": [
"component"
],
"maxLength": 50
},
"postalCode": {
"type": "string",
"title": "postalCode",
"example": "18503",
"description": "The recipient's postal code. ",
"x-tags": [
"component"
],
"maxLength": 20
},
"phoneNumber": {
"type": "string",
"title": "phoneNumber",
"description": "The recipient's phone number.",
"example": "1555555555",
"x-tags": [
"component"
],
"maxLength": 20
},
"phoneNumberCountry": {
"type": "string",
"title": "phoneNumberCountry",
"description": "The country associated with the recipient's phone number.",
"example": "US",
"x-tags": [
"component"
],
"maxLength": 50
},
"mobileNumber": {
"type": "string",
"title": "mobileNumber",
"description": "The recipient's mobile phone number.",
"example": "1555555555",
"x-tags": [
"component"
],
"maxLength": 20
},
"mobileNumberCountry": {
"type": "string",
"title": "mobileNumberCountry",
"description": "The country associated with the mobile phone number.",
"example": "US",
"x-tags": [
"component"
],
"maxLength": 50
}
},
"required": [
"recipientId",
"firstName",
"lastName"
]
},
"examples": {
"Required parameters": {
"value": {
"recipientId": 137256,
"firstName": "John",
"lastName": "Doe"
}
},
"All parameters": {
"value": {
"recipientId": 137256,
"firstName": "John",
"lastName": "Doe",
"recipientIdNumbers": {
"governmentId": "1234567891",
"passportId": "4561231232",
"driversLicenseId": "string",
"employerId": "2468013579"
},
"providerId": "12610",
"recipientRef": "[your_recipient_id]",
"email": "jdoe@example.com",
"userType": "BUSINESS",
"gender": "FEMALE",
"birthDate": "1990-12-05",
"countryOfBirth": "US",
"countryOfNationality": "US",
"country": "US",
"currency": "USD",
"addressType": "BUSINESS",
"addressLine1": "2147 West Silverlake Drive",
"addressLine2": "Apt 42",
"city": "Scranton",
"region": "PA",
"postalCode": "18503",
"phoneNumber": "1555555555",
"phoneNumberCountry": "US",
"mobileNumber": "1555555555",
"mobileNumberCountry": "US"
}
}
}
}
},
"description": ""
},
"tags": [
"Recipients"
]
}
},
"/payout/v3/pay": {
"post": {
"summary": "Submit payouts",
"operationId": "SubmitPayouts",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "1 submitted",
"description": "Message indicates the number of payouts successfully submitted."
}
}
},
"examples": {
"Response for 1 payout": {
"value": {
"message": "1 submitted"
}
},
"Response for multiple payouts": {
"value": {
"message": "30000 submitted"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401"
}
},
"description": "Allows you to submit one or more payouts in the body of an API request.\n\nPayouts can be made to existing recipients or you can create a recipient at the same time as submitting a payout by including the amount and currency for the payout as well as the required parameters for a recipient.\n\n### Required payout parameters\nThe required parameters for a payout are the following:
- `amount`
- `currency`
- The **required recipient parameters**\n\n### Required recipient parameters\nFor sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
- `recipientRef`
- `recipientId`
- `email`
**Note:** The system ignores any other recipient parameters that you include.
\n\nFor sending a payout to a **new recipient**, you must include at least the following recipient parameters:
- `recipientRef`
- `email`
- `firstName`
- `lastName`
- `country`
You may also optionally include any of the other parameters for [creating a recipient](https://docs.nexiopay.com/reference/createrecipient).\n\n\n> 📘 Note \n> \n> For the payout provider Interchecks, if you pass a value for one of the `recipientIdNumbers` parameters when creating a new recipient, you cannot update any recipient information with [Update recipient](https://docs.nexiopay.com/reference/updaterecipient) endpoint.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).
Include all the required parameters for a payout and a recipient, depending on whether this is for a new or existing recipient (see above).\n\n\n\n## Request parameters\n- payouts\n- payouts.amount\n- payouts.currency\n- payouts.recipient\n- payouts.recipient.recipientRef\n- payouts.recipient.recipientId\n- payouts.recipient.email\n- payouts.recipient.firstName\n- payouts.recipient.lastName\n- payouts.recipient.country\n- payouts.recipient.providerId\n- payouts.recipient.userType\n- payouts.recipient.gender\n- payouts.recipient.birthDate\n- payouts.recipient.countryOfBirth\n- payouts.recipient.countryOfNationality\n- payouts.recipient.currency\n- payouts.recipient.addressType\n- payouts.recipient.addressLine1\n- payouts.recipient.addressLine2\n- payouts.recipient.city\n- payouts.recipient.region\n- payouts.recipient.postalCode\n- payouts.recipient.phoneNumber\n- payouts.recipient.phoneNumberCountry\n- payouts.recipient.mobileNumber\n- payouts.recipient.mobileNumberCountry\n- payouts.recipient.governmentIdType\n- payouts.recipient.recipientIdNumbers\n- payouts.recipient.recipientIdNumbers.governmentId\n- payouts.recipient.recipientIdNumbers.passportId\n- payouts.recipient.recipientIdNumbers.employerId\n- payouts.recipient.recipientIdNumbers.driversLicenseId\n- payouts.description\n- payouts.payoutRef\n- batchRef\n\n## Response parameters\n- message\n\n
",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "Submit payout for existing recipient using RecipientRef",
"type": "object",
"x-tags": [
"object"
],
"description": "",
"properties": {
"payouts": {
"type": "array",
"description": "Array of payouts to submit.",
"items": {
"type": "object",
"description": "Specify one or more payout objects.",
"properties": {
"amount": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/amount"
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/currency"
},
"recipient": {
"type": "object",
"description": "\n> #### Important\n> For sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
- `payouts.recipient.recipientRef`
- `payouts.recipient.recipientId`
- `payouts.recipient.email`
\n> **Note:** The system ignores any other recipient parameters that you include.",
"required": [
"recipientRef"
],
"properties": {
"recipientRef": {
"type": "string",
"title": "recipientRef",
"description": "Your unique identifier for a recipient. This allows for easier synchronization across different systems. \n\n \n> #### Important \n> We strongly recommend that you include this value in your request in order to facilitate payment reconciliation. \n\nIf specified in the payout request for an existing recipient, this value takes precedence over values for `recipientId` and `email`.\n \nOnly required if neither `recipientId` nor `email` are specified in the request for an existing recipient.\n\nOptional parameter for a payout request for a new recipient. However, if not included, the system automatically generates a value for this parameter.",
"example": "[your_recipient_id]",
"x-tags": [
"component"
],
"maxLength": 100
}
}
},
"description": {
"type": "string",
"title": "description",
"description": "Payer's description information for the payout to the specified recipient.",
"x-tags": [
"component"
],
"example": "Sample payout description",
"maxLength": 200
},
"payoutRef": {
"type": "string",
"title": "payoutRef",
"x-tags": [
"component"
],
"description": "Payer's unique reference value for a payout to the specified recipient. This allows for easier synchronization and searching across different systems.",
"maxLength": 100,
"example": "dfbb8efc-6e85-4973-8f2e-69baf8624ae6"
}
},
"required": [
"amount",
"currency",
"recipient"
]
}
},
"batchRef": {
"type": "string",
"title": "batchRef",
"x-tags": [
"component"
],
"description": "Reference value for the payout request.\n\nYou can use your own reference value for the payout request. If you want multiple batches to display as a single group in a report, specify the same value. Using this option allows you to easily view money sent to different payout providers so that you can properly fund those accounts.\n\nIf you do not specify a value, the system generates one that includes \"batch\" and the UTC date and time of the submit payout request. ",
"maxLength": 100,
"example": "batch-2021-10-29T15:52:40.356Z"
}
},
"required": [
"payouts"
]
},
{
"title": "Submit payout for existing recipient using RecipientId",
"type": "object",
"x-tags": [
"object"
],
"description": "",
"properties": {
"payouts": {
"type": "array",
"description": "Array of payouts to submit.",
"items": {
"type": "object",
"description": "Specify one or more payout objects.",
"properties": {
"amount": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/amount"
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/currency"
},
"recipient": {
"type": "object",
"description": "\n> #### Important\n> For sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
- `payouts.recipient.recipientRef`
- `payouts.recipient.recipientId`
- `payouts.recipient.email`
\n> **Note:** The system ignores any other recipient parameters that you include.",
"required": [
"recipientId"
],
"properties": {
"recipientId": {
"type": "integer",
"title": "recipientId",
"description": "The Nexio-generated ID for an existing recipient to send a payout to. \n\nIf specified in the payout request for an existing recipient, this value takes precedence over the value for `email`. If `recipientRef` is specified in the request, this value is ignored.\n\nOnly required if neither `recipientRef` nor `email` are specified in the request for an existing recipient.\n\nNot allowed for a payout request for a new recipient.",
"x-tags": [
"component"
],
"example": 137241
}
}
},
"description": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/description"
},
"payoutRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/payoutRef"
}
},
"required": [
"amount",
"currency",
"recipient"
]
}
},
"batchRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/batchRef"
}
},
"required": [
"payouts"
]
},
{
"title": "Submit payout for existing recipient using email",
"type": "object",
"x-tags": [
"object"
],
"description": "",
"properties": {
"payouts": {
"type": "array",
"description": "Array of payouts to submit.",
"items": {
"type": "object",
"description": "Specify one or more payout objects.",
"properties": {
"amount": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/amount"
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/currency"
},
"recipient": {
"type": "object",
"description": "\n> #### Important\n> For sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
- `payouts.recipient.recipientRef`
- `payouts.recipient.recipientId`
- `payouts.recipient.email`
\n> **Note:** The system ignores any other recipient parameters that you include.",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"title": "email",
"description": "The recipient's email address.\n\nIf either `recipientId` or `recipientRef` is specified in the request for an existing recipient, this value is ignored.\n\nOnly required if neither `recipientId` nor `recipientRef` are specified in the request for an existing recipient.\n\nRequired for a payout request for a new recipient.",
"example": "jdoe@example.com",
"x-tags": [
"component"
],
"maxLength": 200
}
}
},
"description": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/description"
},
"payoutRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/payoutRef"
}
},
"required": [
"amount",
"currency",
"recipient"
]
}
},
"batchRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/batchRef"
}
},
"required": [
"payouts"
]
},
{
"title": "Submit payout for multiple existing recipients using any ID",
"type": "object",
"x-tags": [
"object"
],
"description": "",
"properties": {
"payouts": {
"type": "array",
"description": "Array of payouts to submit.",
"items": {
"type": "object",
"description": "Specify one or more payout objects.",
"properties": {
"amount": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/amount"
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/currency"
},
"recipient": {
"type": "object",
"description": "\n> #### Important\n> For sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
- `payouts.recipient.recipientRef`
- `payouts.recipient.recipientId`
- `payouts.recipient.email`
\n> **Note:** The system ignores any other recipient parameters that you include.",
"properties": {
"recipientRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/recipient/properties/recipientRef"
},
"recipientId": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/1/properties/payouts/items/properties/recipient/properties/recipientId"
},
"email": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/2/properties/payouts/items/properties/recipient/properties/email"
}
}
},
"description": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/description"
},
"payoutRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/payoutRef"
}
},
"required": [
"amount",
"currency",
"recipient"
]
}
},
"batchRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/batchRef"
}
},
"required": [
"payouts"
]
},
{
"title": "Submit payout for new recipient",
"type": "object",
"x-tags": [
"object"
],
"description": "",
"properties": {
"payouts": {
"type": "array",
"description": "Array of payouts to submit.",
"items": {
"type": "object",
"description": "Specify one or more payout objects.",
"properties": {
"amount": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/amount"
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/currency"
},
"recipient": {
"type": "object",
"description": "\n> #### Important\n> For sending a payout to a **new recipient**, you must include at least the following recipient parameters:
- `payouts.recipient.recipientRef`
- `payouts.recipient.email`
- `payouts.recipient.firstName`
- `payouts.recipient.lastName`
- `payouts.recipient.country`
\n> You may also optionally include any of the other parameters for creating a recipient.",
"required": [
"recipientRef",
"email",
"firstName",
"lastName",
"country"
],
"properties": {
"recipientRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/recipient/properties/recipientRef"
},
"email": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/2/properties/payouts/items/properties/recipient/properties/email"
},
"firstName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/firstName"
},
"lastName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/lastName"
},
"country": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/country"
},
"providerId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/providerId"
},
"userType": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/userType"
},
"gender": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/gender"
},
"birthDate": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/birthDate"
},
"countryOfBirth": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfBirth"
},
"countryOfNationality": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfNationality"
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/post/requestBody/content/application~1json/schema/properties/currency"
},
"addressType": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressType"
},
"addressLine1": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine1"
},
"addressLine2": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine2"
},
"city": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/city"
},
"region": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/region"
},
"postalCode": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/postalCode"
},
"phoneNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/phoneNumber"
},
"phoneNumberCountry": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/phoneNumberCountry"
},
"mobileNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/mobileNumber"
},
"mobileNumberCountry": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/mobileNumberCountry"
},
"governmentIdType": {
"$ref": "#/paths/~1payout~1v3~1recipient/post/requestBody/content/application~1json/schema/properties/governmentIdType"
},
"recipientIdNumbers": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/recipientIdNumbers"
}
}
},
"description": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/description"
},
"payoutRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/payoutRef"
}
},
"required": [
"amount",
"currency",
"recipient"
]
}
},
"batchRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/batchRef"
}
},
"required": [
"payouts"
]
},
{
"title": "Submit payouts for new and existing recipients",
"type": "object",
"x-tags": [
"object"
],
"description": "You can submit payouts for one or more recipients. There can be a mix of new and existing recipients.\n\n\n> #### Important\n> For sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
- `payouts.recipient.recipientRef`
- `payouts.recipient.recipientId`
- `payouts.recipient.email`
\n> **Note:** The system ignores any other recipient parameters that you include.
\n>\n> For sending a payout to a **new recipient**, you must include at least the following recipient parameters:
- `payouts.recipient.recipientRef`
- `payouts.recipient.email`
- `payouts.recipient.firstName`
- `payouts.recipient.lastName`
- `payouts.recipient.country`
\n> You may also optionally include any of the other parameters for creating a recipient.",
"properties": {
"payouts": {
"type": "array",
"description": "Array of payouts to submit.",
"items": {
"type": "object",
"description": "Specify one or more payout objects.",
"properties": {
"amount": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/amount"
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/currency"
},
"recipient": {
"type": "object",
"description": "\n> #### Important\n> For sending a payout to an **existing recipient**, you must specify one or more of the following recipient parameters (if you specify more than one, they are prioritized in the given order):
- `payouts.recipient.recipientRef`
- `payouts.recipient.recipientId`
- `payouts.recipient.email`
\n> **Note:** The system ignores any other recipient parameters that you include.
\n>\n> For sending a payout to a **new recipient**, you must include at least the following recipient parameters:
- `payouts.recipient.recipientRef`
- `payouts.recipient.email`
- `payouts.recipient.firstName`
- `payouts.recipient.lastName`
- `payouts.recipient.country`
\n> You may also optionally include any of the other parameters for creating a recipient.",
"properties": {
"recipientRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/recipient/properties/recipientRef"
},
"recipientId": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/1/properties/payouts/items/properties/recipient/properties/recipientId"
},
"email": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/2/properties/payouts/items/properties/recipient/properties/email"
},
"providerId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/providerId"
},
"userType": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/userType"
},
"firstName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/firstName"
},
"lastName": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/lastName"
},
"gender": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/gender"
},
"birthDate": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/birthDate"
},
"countryOfBirth": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfBirth"
},
"countryOfNationality": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/countryOfNationality"
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/post/requestBody/content/application~1json/schema/properties/currency"
},
"addressType": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressType"
},
"addressLine1": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine1"
},
"addressLine2": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/addressLine2"
},
"city": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/city"
},
"region": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/region"
},
"postalCode": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/postalCode"
},
"country": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/country"
},
"phoneNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/phoneNumber"
},
"phoneNumberCountry": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/phoneNumberCountry"
},
"mobileNumber": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/mobileNumber"
},
"mobileNumberCountry": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/mobileNumberCountry"
},
"governmentIdType": {
"$ref": "#/paths/~1payout~1v3~1recipient/post/requestBody/content/application~1json/schema/properties/governmentIdType"
},
"recipientIdNumbers": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/recipientIdNumbers"
}
}
},
"description": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/description"
},
"payoutRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/payouts/items/properties/payoutRef"
}
},
"required": [
"amount",
"currency",
"recipient"
]
}
},
"batchRef": {
"$ref": "#/paths/~1payout~1v3~1pay/post/requestBody/content/application~1json/schema/oneOf/0/properties/batchRef"
}
},
"required": [
"payouts"
]
}
]
},
"examples": {
"Single existing recipient": {
"value": {
"payouts": [
{
"amount": 20.25,
"currency": "USD",
"recipient": {
"recipientId": 137245,
"providerId": 12610
},
"description": "Payout for company"
}
]
}
},
"Multiple existing recipients": {
"value": {
"payouts": [
{
"amount": 18.7,
"currency": "USD",
"recipient": {
"recipientId": 137237
}
},
{
"amount": 23.18,
"currency": "EUR",
"recipient": {
"recipientRef": "[your_recipient_id]"
}
},
{
"amount": 23.72,
"currency": "USD",
"recipient": {
"recipientId": 137240
}
},
{
"amount": 45.32,
"currency": "AUD",
"recipient": {
"recipientId": 137245
}
}
]
}
},
"Single new recipient": {
"value": {
"payouts": [
{
"amount": 20.25,
"currency": "USD",
"recipient": {
"recipientRef": "[your_recipient_id]",
"email": "jdoe@example.com",
"firstName": "John",
"lastName": "Doe",
"country": "US"
},
"description": "Payout for company"
}
]
}
},
"Single new recipient with all parameters": {
"value": {
"payouts": [
{
"amount": 25.57,
"currency": "USD",
"recipient": {
"recipientId": 137241,
"recipientRef": "ABC-1234567890",
"email": "jdoe@example.com",
"firstName": "John",
"lastName": "Doe",
"providerId": 12610,
"userType": "INDIVIDUAL",
"birthDate": "1990-12-05",
"countryOfBirth": "US",
"countryOfNationality": "US",
"gender": "MALE",
"addressType": "RESIDENTIAL",
"addressLine1": "2147 West Silverlake Drive",
"addressLine2": "Apt. 42",
"city": "Scranton",
"region": "PA",
"postalCode": "18503",
"country": "US",
"currency": "USD",
"phoneNumber": "1555555555",
"phoneNumberCountry": "US",
"mobileNumber": "18011234567",
"mobileNumberCountry": "US",
"governmentIdType": "SSN",
"recipientIdNumbers": {
"governmentId": "1234567891",
"passportId": "4561231232",
"driversLicenseId": "7890111113",
"employerId": "2468013579"
}
},
"description": "Sample payout description",
"payoutRef": "dfbb8efc-6e85-4973-8f2e-69baf8624ae6"
}
],
"batchRef": "batch-2021-10-29T15:52:40.356Z"
}
}
}
}
}
},
"security": [
{
"Basic_Authentication": []
}
],
"tags": [
"Payouts"
]
}
},
"/payout/v3/spendbackRefund": {
"post": {
"summary": "Spendback refund",
"operationId": "SpendbackRefund",
"description": "Allows the merchant to refund recipients who have previously made a spendback transaction.\n\n\n> ⚠️ Try It\n> \n> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).
Include at least the spendback ID and amount to refund in the request.\n\n\n\n## Request parameters\n- spendbackId\n- amount\n- payoutAccountId\n- recipientId\n- providerId\n- spendbackRef\n- recipientRef\n- providerSpendbackRef\n- currency\n- providerType\n- spendbackType\n- spendbackStatus\n- spendbackDate\n- createdAt\n- updatedAt\n\n## Response parameters\n- spendbackId\n- payoutAccountId\n- recipientId\n- providerId\n- spendbackRef\n- recipientRef\n- providerSpendbackRef\n- amount\n- currency\n- providerType\n- spendbackType\n- spendbackStatus\n- spendbackDate\n- createdAt\n- updatedAt\n\n
",
"security": [
{
"Basic_Authentication": []
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"spendbackId": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/spendbackId"
},
"payoutAccountId": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/payoutAccountId"
},
"recipientId": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/recipientId"
},
"providerId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/providerId"
},
"spendbackRef": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/spendbackRef"
},
"recipientRef": {
"type": "string",
"title": "recipientRef",
"description": "Your unique identifier for a recipient. This is the payer account used for the spendback.",
"example": "[your_recipient_id]",
"x-tags": [
"component"
],
"maxLength": 100
},
"providerSpendbackRef": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/providerSpendbackRef"
},
"amount": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/amount"
},
"currency": {
"type": "string",
"title": "currency",
"description": "The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the spendback by the specified payer.",
"example": "USD",
"x-tags": [
"component"
],
"maxLength": 3
},
"providerType": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/providerType"
},
"spendbackType": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/spendbackType"
},
"spendbackStatus": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/spendbackStatus"
},
"spendbackDate": {
"$ref": "#/paths/~1payout~1v3~1spendbackRefund/post/requestBody/content/application~1json/schema/properties/spendbackDate"
},
"updatedAt": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/updatedAt"
},
"createdAt": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/responses/200/content/application~1json/schema/properties/createdAt"
}
}
},
"examples": {
"Example response": {
"value": {
"spendbackId": 2598,
"payoutAccountId": 3927,
"recipientId": 137241,
"providerId": "12610",
"spendbackRef": "43b57dce-4dca-474a-84f4-4684f3a8aa52",
"recipientRef": "[your_recipient_id]",
"providerSpendbackRef": "spnd_bk_519cbf18-b472-11ec-a6cf-06ff2a295e6f",
"amount": 25.57,
"currency": "USD",
"providerType": 10,
"spendbackType": 20,
"spendbackStatus": 20,
"spendbackDate": "2022-02-26T13:35:00Z",
"updatedAt": "2019-02-23T05:39:59.000Z",
"createdAt": "2019-02-21T05:39:59.000Z"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401"
},
"433": {
"description": "Spendback to refund not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Spendback to refund not found",
"description": "A message from Nexio about the state of the request."
}
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"spendbackId": {
"type": "integer",
"title": "spendbackId",
"x-tags": [
"component"
],
"description": "The ID value auto-generated by Nexio when the spendback request was submitted (see the [Submit spendback](https://docs.nexiopay.com/reference/SubmitSpendback) endpoint).",
"example": 2598
},
"amount": {
"type": "number",
"title": "amount",
"description": "The payout amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.",
"x-tags": [
"component"
],
"example": 25.57
},
"payoutAccountId": {
"type": "integer",
"title": "payoutAccountId",
"description": "The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient.",
"x-tags": [
"component"
],
"example": 3927
},
"recipientId": {
"type": "integer",
"title": "recipientId",
"description": "The Nexio-generated ID for a recipient. This is the payer account used for the spendback refund.",
"x-tags": [
"component"
],
"example": 137241
},
"providerId": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/providerId"
},
"spendbackRef": {
"type": "string",
"title": "spendbackRef",
"x-tags": [
"component"
],
"description": "Reference value for the spendback request. This allows for easier synchronization and searching across different systems.",
"maxLength": 100,
"example": "43b57dce-4dca-474a-84f4-4684f3a8aa52"
},
"recipientRef": {
"type": "string",
"title": "recipientRef",
"description": "Payer's unique reference value for the recipient. This allows for easier synchronization and searching across different systems. This is the same `recipientRef` that is used in the [Submit spendback](https://docs.nexiopay.com/reference/submitspendback) endpoint and is a unique value used for spendbacks.",
"example": "[your_recipient_ref]",
"x-tags": [
"component"
],
"maxLength": 100
},
"providerSpendbackRef": {
"type": "string",
"title": "providerSpendbackRef",
"description": "Reference value for the spendback from the payout provider. This allows for easier synchronization and searching across different systems.",
"x-tags": [
"component"
],
"example": "spnd_bk_519cbf18-b472-11ec-a6cf-06ff2a295e6f",
"maxLength": 100
},
"currency": {
"$ref": "#/paths/~1payout~1v3~1recipient/put/requestBody/content/application~1json/schema/properties/currency"
},
"providerType": {
"type": "integer",
"title": "providerType",
"x-tags": [
"component"
],
"description": "The Nexio ID for the payout provider used to process the spendback request.\n\nPossible values include the following:\n- 10 - Interchecks\n- 20 - Hyperwallet\n- 30 - Payquicker \n- 40 - Nexio's mock payout provider for quicker sandbox integration\n- 50 - MassPay\n- 60 - Nomad",
"example": 10,
"enum": [
10,
20,
30,
40,
50,
60
]
},
"spendbackType": {
"type": "integer",
"title": "spendbackType",
"description": "The type of spendback used.\n\n`10` is `spendback` and `20` is `refund`.",
"example": 20,
"enum": [
10,
20
],
"x-tags": [
"component"
]
},
"spendbackStatus": {
"type": "integer",
"title": "spendbackStatus",
"description": "The status of the spendback, returned as an integer. For more information about possible values, see the [spendbackStatus](https://docs.nexiopay.com/docs/constant-payouts-values#spendback-status-spendbackstatus) table.",
"x-tags": [
"component"
],
"example": 20,
"enum": [
10,
20,
30,
40,
50,
90
]
},
"spendbackDate": {
"type": "string",
"title": "spendbackDate",
"description": "The date the spendback request was sent to the provider, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.",
"format": "date",
"example": "2022-02-26T13:35:00Z",
"x-tags": [
"component"
]
},
"updatedAt": {
"type": "string",
"title": "updatedAt",
"description": "The date and time the spendback record was most recently updated in Nexio, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.",
"example": "2022-02-27T05:39:59.000Z",
"x-tags": [
"component"
]
},
"createdAt": {
"type": "string",
"title": "createdAt",
"description": "The date and time the spendback request was sent to the provider, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.",
"example": "2022-02-26T13:35:00Z",
"x-tags": [
"component"
]
}
},
"required": [
"spendbackId",
"amount"
]
},
"examples": {
"Required parameters": {
"value": {
"spendbackId": 2598,
"amount": 25.57
}
},
"All parameters": {
"value": {
"spendbackId": 2598,
"amount": 25.57,
"payoutAccountId": 3927,
"recipientId": 137241,
"providerId": "12610",
"spendbackRef": "43b57dce-4dca-474a-84f4-4684f3a8aa52",
"recipientRef": "[your_recipient_ref]",
"providerSpendbackRef": "spnd_bk_519cbf18-b472-11ec-a6cf-06ff2a295e6f",
"currency": "USD",
"providerType": 10,
"spendbackType": 10,
"spendbackStatus": 10,
"spendbackDate": "2022-02-26T13:35:00Z",
"updatedAt": "2022-02-27T05:39:59.000Z",
"createdAt": "2022-02-26T13:35:00Z"
}
}
}
}
},
"description": "The `id` parameter is a spendback ID and is required for the request. This spendback ID is generated from using the [Submit spendback](https://docs.nexiopay.com/reference/submitspendback) endpoint, and cannot be obtained in a different way. A spendback must be successfully submitted before issuing a spendback refund. \n\nThe `amount` parameter is also required."
},
"tags": [
"Spendbacks"
],
"parameters": []
},
"parameters": []
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```