Payouts

POST {{baseUrl}}/API/Payments?key={{apiKey}}

Request Params

Key	Datatype	Required	Description
`key`	string

Request Body

[{"name"=>"request", "value"=>"<APIPaymentsRequest>\n    <Header>\n        <PsVer>2.0.1</PsVer>\n        <Client>{{clientCode}}</Client>\n        <Service>{{service}}</Service>\n        <ServiceType>{{serviceType}}</ServiceType>\n        <UniqueId>{{$guid}}</UniqueId>\n        <DueDate>20200917</DueDate>\n        <CallbackUrl>{{callbackUrl}}</CallbackUrl>\n        <Reference>REF{{$randomInt}}</Reference>\n    </Header>\n    <Payments>\n        <FileContents>\n            <Initial>JS</Initial>\n            <FirstName>Joe</FirstName>\n            <Surname>Doe</Surname>\n            <BranchCode>157852</BranchCode>\n            <AccountNumber>1203389809</AccountNumber>\n            <FileAmount>1.00</FileAmount>\n            <AccountType>0</AccountType>\n            <AmountMultiplier>1</AmountMultiplier>\n            <Reference>{{$randomCompanyName}}</Reference>\n        </FileContents>\n    </Payments>\n    <Totals>\n        <Records>1</Records>\n        <Amount>1.00</Amount>\n        <BranchHash>157852</BranchHash>\n        <AccountHash>1203389809</AccountHash>\n    </Totals>\n</APIPaymentsRequest>", "datatype"=>"string"}]

RESPONSES

status: OK

&quot;\u003c?xml version=\&quot;1.0\&quot; encoding=\&quot;utf-8\&quot; standalone=\&quot;yes\&quot;?\u003e\n\u003cResponse\u003e\n    \u003cResult\u003eOK\u003c/Result\u003e\n    \u003cBatchCode\u003e30104\u003c/BatchCode\u003e\n    \u003cPaymentResults\u003e\n        \u003cResult\u003e\n            \u003cAccountNumber\u003e123456789\u003c/AccountNumber\u003e\n            \u003cBranchCode\u003e632005\u003c/BranchCode\u003e\n            \u003cFirstName\u003eExample\u003c/FirstName\u003e\n            \u003cSurname\u003eCallback\u003c/Surname\u003e\n            \u003cReference\u003eSALARY\u003c/Reference\u003e\n            \u003cCustomerCode\u003e000001\u003c/CustomerCode\u003e\n            \u003cResult\u003eRejected\u003c/Result\u003e\n            \u003cResultMessage\u003eACCOUNT CLOSED\u003c/ResultMessage\u003e\n        \u003c/Result\u003e\n    \u003c/PaymentResults\u003e\n\u003c/Response\u003e&quot;