Store a payment data map | Payment API 0.1.0

Authorization

Default

AuthorizationBearer <token>

In: header

Header Parameters

X-Request-Id?string

Optional request identifier for tracing and support. A UUID is recommended. Axiym echoes it in X-Request-Id, or generates one when omitted.

Formatuuid

Idempotency-Key*string

Identifies one state-changing operation. Retry with the same endpoint, request body, and key to receive the original result without repeating the operation. Use a new key for a new operation, including confirmation after creation.

Lengthlength <= 255

Request Body

application/json

Name, optional description, and mapping definition to store.

name*string

Name used to identify the stored map in your integration.

Length1 <= length <= 120

description?string

Optional note describing the source structures or integration that uses this map.

Lengthlength <= 500

definition*PaymentDataMapDefinition

Reusable rules that transform your complete payment JSON into the Axiym payout input. Field paths are relative to the payment object sent to POST /payouts/mapped. The definition stores rules and reviewed labels, not payment records or file content. Definitions are immutable; store changed rules as a new map. Unsupported schema versions are rejected.

Response Body

`application/json`

curl -X POST "https://example.com/payment-data-maps" \  -H "Idempotency-Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890" \  -H "Content-Type: application/json" \  -d '{    "name": "Supplier payments",    "definition": {      "schemaVersion": "3",      "fields": [        {          "source": "instruction.account",          "target": "sourceAccountId"        },        {          "source": "instruction.total",          "target": "amount.amount"        },        {          "source": "instruction.currency",          "target": "amount.currency"        },        {          "source": "instruction.reason",          "target": "purpose"        },        {          "source": "instruction.funding",          "target": "sourceOfFunds"        },        {          "source": "instruction.reference",          "target": "reference"        },        {          "source": "beneficiary.name",          "target": "recipient.name"        },        {          "source": "beneficiary.relationship",          "target": "recipient.businessRelationship"        },        {          "source": "beneficiary.address.line",          "target": "recipient.address.streetName"        },        {          "source": "beneficiary.address.city",          "target": "recipient.address.city"        },        {          "source": "beneficiary.address.country",          "target": "recipient.address.country"        },        {          "source": "beneficiary.account.number",          "target": "recipient.destination.accountNumber"        },        {          "source": "beneficiary.account.currency",          "target": "recipient.destination.currency"        },        {          "source": "beneficiary.account.bank.name",          "target": "recipient.destination.bank.bankName"        },        {          "source": "beneficiary.account.bank.swift",          "target": "recipient.destination.bank.swiftBic"        },        {          "source": "beneficiary.account.bank.country",          "target": "recipient.destination.bank.address.country"        }      ],      "documents": [        {          "target": "supportingDocuments[]",          "source": "files[]",          "association": "linked",          "fields": {            "documentType": "kind",            "name": "fileName",            "data": "content"          },          "matches": [            {              "fileField": "ownerId",              "recordPath": "instruction.reference"            }          ],          "filters": [            {              "field": "usage",              "value": "payment"            }          ]        }      ],      "values": [        {          "source": "instruction.reason",          "targets": [            "purpose"          ],          "translations": {            "supplier invoice": "GOODS_PURCHASE"          }        },        {          "source": "instruction.funding",          "targets": [            "sourceOfFunds"          ],          "translations": {            "business income": "BUSINESS_INCOME"          }        },        {          "source": "beneficiary.relationship",          "targets": [            "recipient.businessRelationship"          ],          "translations": {            "supplier": "SUPPLIER"          }        },        {          "source": "files[].kind",          "targets": [            "supportingDocuments[].documentType"          ],          "translations": {            "invoice": "INVOICE"          }        }      ],      "sender": "onboarded-profile",      "amountResolution": {        "method": "currency",        "fundingAccount": "sourceAccountId",        "recipientCurrency": "recipient.destination.currency",        "whenBothMatch": "sourceAmount",        "whenNeitherMatches": "reject"      }    }  }'

{  "paymentDataMapId": "b761aae2-53f6-4cf2-82ff-1155abbe37d5",  "name": "string",  "description": "string",  "definition": {    "schemaVersion": "3",    "fields": [      {        "source": "instruction.account",        "target": "sourceAccountId"      },      {        "source": "instruction.total",        "target": "amount.amount"      },      {        "source": "instruction.currency",        "target": "amount.currency"      },      {        "source": "instruction.reason",        "target": "purpose"      },      {        "source": "instruction.funding",        "target": "sourceOfFunds"      },      {        "source": "instruction.reference",        "target": "reference"      },      {        "source": "beneficiary.name",        "target": "recipient.name"      },      {        "source": "beneficiary.relationship",        "target": "recipient.businessRelationship"      },      {        "source": "beneficiary.address.line",        "target": "recipient.address.streetName"      },      {        "source": "beneficiary.address.city",        "target": "recipient.address.city"      },      {        "source": "beneficiary.address.country",        "target": "recipient.address.country"      },      {        "source": "beneficiary.account.number",        "target": "recipient.destination.accountNumber"      },      {        "source": "beneficiary.account.currency",        "target": "recipient.destination.currency"      },      {        "source": "beneficiary.account.bank.name",        "target": "recipient.destination.bank.bankName"      },      {        "source": "beneficiary.account.bank.swift",        "target": "recipient.destination.bank.swiftBic"      },      {        "source": "beneficiary.account.bank.country",        "target": "recipient.destination.bank.address.country"      }    ],    "documents": [      {        "target": "supportingDocuments[]",        "source": "files[]",        "association": "linked",        "fields": {          "documentType": "kind",          "name": "fileName",          "data": "content"        },        "matches": [          {            "fileField": "ownerId",            "recordPath": "instruction.reference"          }        ],        "filters": [          {            "field": "usage",            "value": "payment"          }        ]      }    ],    "values": [      {        "source": "instruction.reason",        "targets": [          "purpose"        ],        "translations": {          "supplier invoice": "GOODS_PURCHASE"        }      },      {        "source": "instruction.funding",        "targets": [          "sourceOfFunds"        ],        "translations": {          "business income": "BUSINESS_INCOME"        }      },      {        "source": "beneficiary.relationship",        "targets": [          "recipient.businessRelationship"        ],        "translations": {          "supplier": "SUPPLIER"        }      },      {        "source": "files[].kind",        "targets": [          "supportingDocuments[].documentType"        ],        "translations": {          "invoice": "INVOICE"        }      }    ],    "sender": "onboarded-profile",    "amountResolution": {      "method": "currency",      "fundingAccount": "sourceAccountId",      "recipientCurrency": "recipient.destination.currency",      "whenBothMatch": "sourceAmount",      "whenNeitherMatches": "reject"    }  },  "status": "ACTIVE",  "contentHash": "sha256:8a4b22d6421e6349c74b6814880d19c9c96a73427bb42d088d057f15c17b37e7",  "createdAt": "2019-08-24T14:15:22Z"}

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`