AZA Finance
TransferZero API V1

Cross-border FX and payout API from AZA Finance. Create senders and recipients, quote and create transactions, fund payins, trigger payouts, validate accounts, manage payout/payin methods and KYC documents, and subscribe to webhooks. 49 operations, HMAC authentication, page/per pagination, external_id idempotency.
Documentation GitHub OpenAPI
OpenAPI Specification

{
  "openapi" : "3.0.2",
  "info" : {
    "title" : "TransferZero API",
    "description" : "Reference documentation for the TransferZero API V1",
    "version" : "1.0"
  },
  "externalDocs" : {
    "description" : "API documentation and onboarding guide",
    "url" : "https://docs.transferzero.com/"
  },
  "servers" : [ {
    "url" : "https://api-sandbox.transferzero.com/v1"
  }, {
    "url" : "https://api.transferzero.com/v1"
  } ],
  "security" : [ {
    "AuthorizationKey" : [ ],
    "AuthorizationNonce" : [ ],
    "AuthorizationSignature" : [ ]
  }, {
    "AuthorizationKey" : [ ],
    "AuthorizationSecret" : [ ]
  } ],
  "paths" : {
    "/accounts" : {
      "get" : {
        "tags" : [ "Accounts" ],
        "summary" : "Fetches account balances for all currencies",
        "description" : "Fetches account balances for all currencies, and returns an array of the current balances and associated currency codes.",
        "operationId" : "get-accounts",
        "responses" : {
          "200" : {
            "description" : "Array of account balances",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AccountListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/accounts/{Currency}" : {
      "get" : {
        "tags" : [ "Accounts" ],
        "summary" : "Fetches account balance for specified currrency",
        "description" : "Fetches account balance for specified currrency, and returns current balance and associated currency code",
        "operationId" : "get-account",
        "parameters" : [ {
          "name" : "Currency",
          "in" : "path",
          "description" : "Currency code of account balance to fetch\n\nExample: `/v1/accounts/USD`",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Account balance for currency",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AccountResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "404" : {
            "description" : "Resource Not Found."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/accounts/debits" : {
      "post" : {
        "tags" : [ "Account Debits" ],
        "summary" : "Creating an account debit",
        "description" : "Creates a new account debit finding transaction through the internal balance\n\nTo successfully fund a transaction -\n- The currency needs to be the same as the input_currency on the transaction\n- The amount has to be the same as the input_amount on the transaction\n- The to_id is the id of the transaction\n- You need to have enough balance of the appropriate currency inside your wallet\n\nOnce the transaction is funded, we will immediately start trying to pay out the recipient(s).\n\nIt is also possible to create multiple account debits by supplying an array of debit objects\n",
        "externalDocs" : {
          "description" : "Funding Transaction guide including alternative ways to fund transactions.",
          "url" : "https://docs.transferzero.com/docs/transaction-flow/#funding-transactions"
        },
        "operationId" : "post-accounts-debits",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/DebitRequestWrapper"
              },
              "examples" : {
                "single_debit" : {
                  "summary" : "Single Debit",
                  "value" : {
                    "debit" : {
                      "currency" : "NGN",
                      "amount" : "2000.0",
                      "to_id" : "5f44026b-7904-4c30-87d6-f8972d790ded",
                      "to_type" : "Transaction"
                    }
                  }
                },
                "multiple_debit" : {
                  "summary" : "Multiple Debit",
                  "value" : {
                    "debit" : [ {
                      "currency" : "NGN",
                      "amount" : 2.0,
                      "to_id" : "d9269c2a-7049-4625-b3b8-30e25ad33162",
                      "to_type" : "Transaction",
                      "metadata" : {
                        "id" : "b783a4f5-a959-4a1f-87fa-112fe6eae9e4"
                      }
                    }, {
                      "currency" : "NGN",
                      "amount" : 2.0,
                      "to_id" : "912973a9-e027-4768-8e98-5a8f44469bf4",
                      "to_type" : "Transaction",
                      "metadata" : {
                        "id" : "4900f50a-bfb6-469f-ad0e-8c8cf0ef5dfa"
                      }
                    } ]
                  }
                }
              }
            }
          },
          "required" : true
        },
        "responses" : {
          "201" : {
            "description" : "Account Debit details",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DebitListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "422" : {
            "description" : "Invalid account debit object (includes errors object)",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DebitListResponse"
                }
              }
            }
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        }
      }
    },
    "/account_validations" : {
      "post" : {
        "tags" : [ "Account Validation" ],
        "summary" : "Validates the existence of a bank account or a mobile phone number",
        "description" : "Validates the existence of a bank account or mobile phone number and returns the associated customer name",
        "externalDocs" : {
          "description" : "More information on account validation and bank account name enquiry",
          "url" : "https://docs.transferzero.com/docs/additional-features/#account-name-enquiry"
        },
        "operationId" : "post-account-validations",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AccountValidationRequest"
              },
              "examples" : {
                "bank" : {
                  "summary" : "Bank Account Validation",
                  "value" : {
                    "bank_account" : "12345678",
                    "bank_code" : "050",
                    "country" : "NG",
                    "currency" : "NGN",
                    "method" : "bank"
                  }
                },
                "bank_with_iban" : {
                  "summary" : "Bank account Validation using IBAN in BBAN format",
                  "value" : {
                    "iban" : "CI1630120200000018678768",
                    "country" : "CI",
                    "currency" : "XOF",
                    "method" : "bank"
                  }
                },
                "mobile" : {
                  "summary" : "Mobile Phone Number Validation",
                  "value" : {
                    "phone_number" : "+233000000000",
                    "country" : "GH",
                    "currency" : "GHS",
                    "method" : "mobile"
                  }
                }
              }
            }
          },
          "required" : true
        },
        "responses" : {
          "200" : {
            "description" : "Success - Account details found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AccountValidationResponse"
                }
              }
            }
          },
          "422" : {
            "description" : "Error - Account details not found",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AccountValidationResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        }
      }
    },
    "/api_logs" : {
      "get" : {
        "tags" : [ "API Logs" ],
        "summary" : "Fetch a list of API logs",
        "description" : "Returns a list of API logs. Also includes information relating to the original request.",
        "operationId" : "get-api-logs",
        "parameters" : [ {
          "name" : "page",
          "in" : "query",
          "description" : "The page number to request (defaults to 1)",
          "required" : false,
          "schema" : {
            "type" : "integer"
          },
          "example" : 1
        }, {
          "name" : "per",
          "in" : "query",
          "description" : "The number of results to load per page (defaults to 10)",
          "required" : false,
          "schema" : {
            "type" : "integer"
          },
          "example" : 10
        }, {
          "name" : "created_at_from",
          "in" : "query",
          "description" : "Start date to filter recipients by created_at range\nAllows filtering results by the specified `created_at` timeframe.\n\nExample: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`",
          "required" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "created_at_to",
          "in" : "query",
          "description" : "End date to filter recipients by created_at range\nAllows filtering results by the specified `created_at` timeframe.\n\nExample: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`",
          "required" : false,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "API logs returned within an array wrapped inside a JSON object",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ApiLogListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/api_logs/{API Log ID}" : {
      "get" : {
        "tags" : [ "API Logs" ],
        "summary" : "Fetch an individual API log",
        "description" : "Returns a single API log based on the API log ID.",
        "operationId" : "get-api-log",
        "parameters" : [ {
          "name" : "API Log ID",
          "in" : "path",
          "description" : "ID of the API log to retrieve\n\nExample: `/v1/api_logs/00485ce9-532b-45e7-8518-7e5582242407`",
          "required" : true,
          "schema" : {
            "type" : "string",
            "format" : "uuid"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Details of requested API log",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/ApiLogResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "404" : {
            "description" : "Resource Not Found."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/dlocal/balance" : {
      "get" : {
        "tags" : [ "dlocal balance" ],
        "summary" : "Get dlocal balances",
        "description" : "This endpoint retrieves dlocal account balances",
        "operationId" : "get-balance",
        "responses" : {
          "200" : {
            "description" : "Array of balances",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DlocalBalanceResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        }
      }
    },
    "/info/currencies" : {
      "get" : {
        "tags" : [ "Currency Info" ],
        "summary" : "Getting a list of possible requested currencies",
        "description" : "Fetches a list of currencies available to use in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier.",
        "operationId" : "info-currencies",
        "responses" : {
          "200" : {
            "description" : "Returns the available currencies in the system",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/CurrencyListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/info/currencies/in" : {
      "get" : {
        "tags" : [ "Currency Info" ],
        "summary" : "Getting a list of possible input currencies",
        "description" : "Fetches a list of currencies available to use as the input currency in other API requests.\nUsually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier.\nUse this endpoint to determine the current exchange rate from a specific input currency to any output currency that's available.\n",
        "operationId" : "info-currencies-in",
        "parameters" : [ {
          "name" : "sender_id",
          "in" : "query",
          "description" : "Allows the scoping of the results by `sender_id` (optional).\n\nExample: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`",
          "required" : false,
          "schema" : {
            "type" : "string",
            "description" : "ID of the sender to use.",
            "format" : "uuid"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Returns the potential input currencies with their exchange rates",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/CurrencyExchangeListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/info/currencies/out" : {
      "get" : {
        "tags" : [ "Currency Info" ],
        "summary" : "Getting a list of possible output currencies",
        "description" : "Fetches a list of currencies available to use as the output currency and their exchange rates against the available input currencies.\nUsually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier.\n",
        "operationId" : "info-currencies-out",
        "parameters" : [ {
          "name" : "sender_id",
          "in" : "query",
          "description" : "Allows the scoping of the results by `sender_id` (optional).\n\nExample: `/v1/info/currencies/out?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`",
          "required" : false,
          "schema" : {
            "type" : "string",
            "description" : "ID of the sender to use.",
            "format" : "uuid"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Returns the potential output currencies with their exchange rates",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/CurrencyExchangeListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/documents" : {
      "get" : {
        "tags" : [ "Documents" ],
        "summary" : "Getting a list of documents",
        "description" : "Fetches a list of documents.",
        "operationId" : "get-documents",
        "parameters" : [ {
          "name" : "page",
          "in" : "query",
          "description" : "The page number to request (defaults to 1)",
          "required" : false,
          "schema" : {
            "type" : "integer"
          },
          "example" : 1
        }, {
          "name" : "per",
          "in" : "query",
          "description" : "The number of results to load per page (defaults to 10)",
          "required" : false,
          "schema" : {
            "type" : "integer"
          },
          "example" : 10
        } ],
        "responses" : {
          "200" : {
            "description" : "Array of documents requested",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DocumentListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      },
      "post" : {
        "tags" : [ "Documents" ],
        "summary" : "Creating a document",
        "description" : "Creates a new document",
        "operationId" : "post-documents",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/DocumentRequest"
              }
            }
          },
          "required" : true
        },
        "responses" : {
          "201" : {
            "description" : "Details of the created document",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DocumentResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "422" : {
            "description" : "Invalid document object (includes errors object)",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DocumentResponse"
                }
              }
            }
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        }
      }
    },
    "/documents/{Document ID}" : {
      "get" : {
        "tags" : [ "Documents" ],
        "summary" : "Fetching a document",
        "description" : "Returns a single document by the Documents ID",
        "operationId" : "get-document",
        "parameters" : [ {
          "name" : "Document ID",
          "in" : "path",
          "description" : "ID of the document to get.\n\nExample: `/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670`",
          "required" : true,
          "schema" : {
            "type" : "string",
            "format" : "uuid"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Details of requested document",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/DocumentResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "404" : {
            "description" : "Resource Not Found."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/info/payment_methods/in" : {
      "get" : {
        "tags" : [ "Payment Methods" ],
        "summary" : "This method returns possible payin methods.",
        "description" : "Fetching possible payin methods.\n",
        "operationId" : "payment-methods-in",
        "responses" : {
          "200" : {
            "description" : "List of possible methods",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/PaymentMethodListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/info/payment_methods/out" : {
      "get" : {
        "tags" : [ "Payment Methods" ],
        "summary" : "This method returns possible payout methods.",
        "description" : "Fetching possible payout methods.\n",
        "operationId" : "payment-methods-out",
        "responses" : {
          "200" : {
            "description" : "List of possible methods",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/PaymentMethodListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/logs/webhooks" : {
      "get" : {
        "tags" : [ "Logs" ],
        "summary" : "Fetch a list of webhook logs",
        "description" : "Returns a list of webhook logs. Response includes pagination.",
        "operationId" : "get-webhook-logs",
        "parameters" : [ {
          "name" : "page",
          "in" : "query",
          "description" : "The page number to request (defaults to 1)",
          "required" : false,
          "schema" : {
            "type" : "integer"
          },
          "example" : 1
        }, {
          "name" : "per",
          "in" : "query",
          "description" : "The number of results to load per page (defaults to 10)",
          "required" : false,
          "schema" : {
            "type" : "integer"
          },
          "example" : 10
        }, {
          "name" : "created_at_from",
          "in" : "query",
          "description" : "Start date to filter recipients by created_at range\nAllows filtering results by the specified `created_at` timeframe.\n\nExample: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`",
          "required" : false,
          "schema" : {
            "type" : "string"
          }
        }, {
          "name" : "created_at_to",
          "in" : "query",
          "description" : "End date to filter recipients by created_at range\nAllows filtering results by the specified `created_at` timeframe.\n\nExample: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`",
          "required" : false,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Webhook logs returned within an array wrapped inside a JSON object",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/WebhookLogListResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/logs/{Webhook Log ID}" : {
      "get" : {
        "tags" : [ "Logs" ],
        "summary" : "Fetch an individual webhook log",
        "description" : "Returns a single webhook log based on the webhook log ID.",
        "operationId" : "get-webhook-log",
        "parameters" : [ {
          "name" : "Webhook Log ID",
          "in" : "path",
          "description" : "ID of the webhook log to retrieve\n\nExample: `/v1/logs/9d1ad631-f34a-4cff-9a7e-2c83e3a556df`",
          "required" : true,
          "schema" : {
            "type" : "string",
            "format" : "uuid"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Details of requested webhook log",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/WebhookLogResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "404" : {
            "description" : "Resource Not Found."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/mandates/{Mandate ID}" : {
      "get" : {
        "tags" : [ "Mandates" ],
        "summary" : "Fetch a single mandate",
        "description" : "Finds and returns a Mandate created within the current calendar year,\nwhere the mandate is linked to a Recipient owned by the authenticated\nAPI key.\n\nReturns 404 if the mandate is not owned by the API key or was not\nissued in the current calendar year — mandates are only valid for\nthe year in which they were issued.",
        "operationId" : "get-mandate",
        "parameters" : [ {
          "name" : "Mandate ID",
          "in" : "path",
          "description" : "ID of the mandate.\n\nExample: `/v1/mandates/bf9ff782-e182-45ac-abea-5bce83ad6670`",
          "required" : true,
          "schema" : {
            "type" : "string",
            "format" : "uuid"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Mandate object",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/MandateResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "404" : {
            "description" : "Resource Not Found."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      }
    },
    "/payin_methods/{PayinMethod ID}" : {
      "get" : {
        "tags" : [ "Payin Methods" ],
        "summary" : "Fetching a payin method",
        "description" : "Show a payin method by id",
        "operationId" : "get-payin-method",
        "parameters" : [ {
          "name" : "PayinMethod ID",
          "in" : "path",
          "description" : "ID of the payin method to get.\n\nExample: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`",
          "required" : true,
          "schema" : {
            "type" : "string",
            "format" : "uuid"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Success",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/PayinMethodResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "404" : {
            "description" : "Resource Not Found."
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        },
        "x-group-parameters" : true
      },
      "delete" : {
        "tags" : [ "Payin Methods" ],
        "summary" : "Deleting a payin method",
        "description" : "Initiates a cancellation request for the specified payin method",
        "operationId" : "delete-payin-method",
        "parameters" : [ {
          "name" : "PayinMethod ID",
          "in" : "path",
          "description" : "ID of the payin method to delete.\n\nExample: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`",
          "required" : true,
          "schema" : {
            "type" : "string",
            "format" : "uuid"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Details of deleted payin method",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/PayinMethodResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "404" : {
            "description" : "Resource Not Found."
          },
          "422" : {
            "description" : "Invalid payin method object (includes errors object)",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/PayinMethodResponse"
                }
              }
            }
          },
          "500" : {
            "description" : "Internal Server Error."
          }
        }
      },
      "patch" : {
        "tags" : [ "Payin Methods" ],
        "summary" : "Updating a payin method",
        "description" : "Updates a single payin method by the Payin Method ID",
        "operationId" : "patch-payin-method",
        "parameters" : [ {
          "name" : "PayinMethod ID",
          "in" : "path",
          "description" : "ID of the payin method to get.\n\nExample: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`",
          "required" : true,
          "schema" : {
            "type" : "string",
            "format" : "uuid"
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/PayinMethod"
              }
            }
          },
          "required" : true
        },
        "responses" : {
          "200" : {
            "description" : "Details of updated payin method",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/PayinMethodResponse"
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication information is missing or invalid."
          },
          "404" : {
            "description" : "Resource Not Found."
          },
          "422" : {
            "description" : "Invalid payin method object (includes errors object)",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/PayinMethodResponse"
                }
              }
         

# --- truncated at 32 KB (369 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aza-finance/refs/heads/main/openapi/aza-finance-openapi-original.json
TransferZero API V1

Documentation

Specifications

Other Resources

OpenAPI Specification
