{"title":"Initiate payments on behalf of account holders","category":"default","creationDate":1776961628,"content":"<p>As part of the open banking framework for Payment Initiation Service Providers (PISPs), Adyen provides endpoints to initiate payment transactions on behalf of account holders who have given their consent.<\/p>\n<p>This page explains how you, as a third-party PISP, use the <code>\/payments<\/code> endpoint to:<\/p>\n<ul>\n<li><a href=\"#initiate-a-payment\">Initiate a payment<\/a><\/li>\n<li><a href=\"#payment-status\">Get the status of a payment<\/a><\/li>\n<li><a href=\"#authorization-status\">Get the status of a payment authorization<\/a><\/li>\n<\/ul>\n<h2>Requirements<\/h2>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">Not applicable; this documentation is intended for third-party providers.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin, you must: <ul><li>Complete the <a href=\"\/pt\/business-accounts\/open-banking#onboard-with-adyen\">Adyen onboarding steps<\/a>.<\/li><li> Have your <a href=\"\/pt\/business-accounts\/oauth-flow#get-an-access-token\">access token<\/a> for the Adyen business account.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"initiate-a-payment\">Initiate a payment<\/h2>\n<p>To initiate a single payment on behalf of your account holder:<\/p>\n<ol>\n<li>\n<p>Make a POST <code>\/payments\/target-2-payments<\/code> request with the following parameters in the request body. The request header includes, for example, an IPv4 address like 19.68.26.143, or an IPv6 address like 2001:db8:1:1:1:1:1:1.<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>instructedAmount<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The currency and the amount of the payment.<\/td>\n<\/tr>\n<tr>\n<td><code>creditorAccount<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The account number of the creditor\u2014the person or entity who will receive the payment.<\/td>\n<\/tr>\n<tr>\n<td><code>debtorAccount<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The account number of the debtor.<\/td>\n<\/tr>\n<tr>\n<td><code>creditorName<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The name of the creditor.<\/td>\n<\/tr>\n<tr>\n<td><code>creditorAddress<\/code><\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The address of the creditor.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>Here is an example of a request to initiate a payment of <strong>EUR&nbsp;0.50<\/strong> to Railway Company.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Initiate a single payment'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl  'https:\\\/\\\/openbanking-psd2-test.adyen.com\\\/obeu\\\/pisp\\\/v1\\\/payments\\\/target-2-payments' \\\\\\n--header 'X-Request-ID: {your-request-id}' \\\\\\n--header 'IPv4: 19.68.26.143' \\\\\\n--header 'Content-Type: application\\\/json' \\\\\\n--header 'Authorization: Bearer {access_token}' \\\\\\n--data '{\\n    \\&quot;instructedAmount\\&quot;: {\\n        \\&quot;currency\\&quot;: \\&quot;EUR\\&quot;,\\n        \\&quot;amount\\&quot;: \\&quot;0.50\\&quot;\\n    },\\n    \\&quot;creditorAccount\\&quot;: {\\n        \\&quot;iban\\&quot;: \\&quot;NL57INGB4654188101\\&quot;\\n    },\\n    \\&quot;debtorAccount\\&quot;: {\\n        \\&quot;iban\\&quot;: \\&quot;NL91ABNA0417164300\\&quot;\\n    },\\n    \\&quot;creditorName\\&quot;: \\&quot;Railway Company\\&quot;,\\n    \\&quot;creditorAddress\\&quot;: {\\n        \\&quot;streetName\\&quot;: \\&quot;Railstraat\\&quot;,\\n        \\&quot;buildingNumber\\&quot;: \\&quot;1\\&quot;,\\n        \\&quot;townName\\&quot;: \\&quot;Amsterdam\\&quot;,\\n        \\&quot;postCode\\&quot;: \\&quot;2023 AB\\&quot;,\\n        \\&quot;country\\&quot;: \\&quot;NL\\&quot;\\n    }\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>The response contains the details of the initiated payment, including the <code>transactionStatus<\/code> and the <code>paymentId<\/code>. The response contains the following fields:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>transactionStatus<\/code><\/td>\n<td>Current status of the payment. Possible values: <ul><li><strong>ACCP<\/strong>: Accepted customer profile.<\/li><li><strong>ACFC<\/strong>: Accepted funds checked.<\/li><li><strong>ACCC<\/strong>: Accepted settlement completed on the creditor's account.<\/li><li><strong>ACSC<\/strong>: Accepted settlement completed on the debtor's account.<\/li><li><strong>ACSP<\/strong>: Accepted settlement in process.<\/li><li><strong>ACTC<\/strong>: Accepted technical validation.<\/li><li><strong>ACWC<\/strong>: Accepted with change.<\/li><li><strong>ACWP<\/strong>: Accepted without posting.<\/li><li><strong>CANC<\/strong>: Payment initiation has been cancelled before execution.<\/li><li><strong>RCVD<\/strong>: Payment initiation has been received. <\/li><li><strong>RJCT<\/strong>: Payment initiation or individual transaction included in the payment initiation has been rejected. <\/li><li><strong>PDNG<\/strong>: Payment initiation or individual transaction included in the payment initiation is pending.<\/li><li><strong>PART<\/strong>: Partially accepted.<\/li><li><strong>PATC<\/strong>: Partially accepted technical.<\/li><\/td>\n<td><\/td>\n<\/tr>\n<tr>\n<td><code>paymentId<\/code><\/td>\n<td>A list of characters that represents the ID of a specific payment.<\/td>\n<td><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"transactionStatus\\\": \\\"PDNG\\\",\\n    \\\"paymentId\\\": \\\"1WPF9J5ZKOIZH8MG\\\",\\n    \\\"_links\\\": {\\n        \\\"self\\\": {\\n            \\\"href\\\": \\\"\\\/payments\\\/target-2-payments\\\/1WPF9J5ZKOIZH8MG\\\"\\n        },\\n        \\\"status\\\": {\\n            \\\"href\\\": \\\"\\\/payments\\\/target-2-payments\\\/1WPF9J5ZKOIZH8MG\\\/status\\\"\\n        },\\n        \\\"scaStatus\\\": {\\n            \\\"href\\\": \\\"\\\/payments\\\/target-2-payments\\\/1WPF9J5ZKOIZH8MG\\\/authorisations\\\/OBAU4222Z223222P5J6FPG9DG4654T\\\"\\n        }\\n    }\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2 id=\"payment-status\">Get payment status<\/h2>\n<p>To get the status of the payment:<\/p>\n<ol>\n<li>\n<p>Make a GET <code>\/payments\/target-2-payments\/{paymentId}<\/code> request. Use this endpoint to check if the payment has been confirmed. The <code>paymentId<\/code> is found in the response of the <a href=\"#initiate-a-payment\">Initiate a payment<\/a> step.  Keep polling the endpoint for status updates (recommended every 5 seconds).<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Get payment status'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl  'https:\\\/\\\/openbanking-psd2-test.adyen.com\\\/obeu\\\/pisp\\\/v1\\\/payments\\\/target-2-payments\\\/{paymentId}' \\\\\\n--header 'X-Request-ID: {your-request-id}' \\\\\\n--header 'Authorization: Bearer {access_token}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>The response contains the <code>transactionStatus<\/code> which describes the current state of the payment. The response may look like this:<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"transactionStatus\\\": \\\"RCVD\\\",\\n    \\\"paymentId\\\": \\\"1WPF9J5ZKOIZH8MG\\\",\\n    \\\"instructedAmount\\\": {\\n        \\\"currency\\\": \\\"EUR\\\",\\n        \\\"amount\\\": \\\"-0.50\\\"\\n    }\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2 id=\"authorization-status\">Get authorization status<\/h2>\n<p>To get information about the payment authorization details and determine where your account holder is in the in authorization flow to initiate payments.<\/p>\n<ol>\n<li>\n<p>Make a GET <code>\/payments\/target-2-payments\/{paymentId}\/authorisations\/{authorizationId}<\/code> request, where <code>paymentId<\/code> represents a unique identifier for a payment transaction and <code>authorizationId<\/code> is a unique identifier for a specific payment authorization.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Get authorization status'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl  'https:\\\/\\\/openbanking-psd2-test.adyen.com\\\/obeu\\\/pisp\\\/v1\\\/payments\\\/target-2-payments\\\/1WPF9J5Z16P8M825\\\/authorisations\\\/OBAU4222Z223222P5HWJDLHD766H93' \\\\\\n--header 'X-Request-ID: {your-request-id}' \\\\\\n--header 'Authorization: Basic {access_token}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>The response contains the authorization status. See the <code>scaStatus<\/code> for all possible values.<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameter<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>scaStatus<\/code><\/td>\n<td>Status of authorization. Possible values: <ul><li><strong>scaMethodSelected<\/strong>: The account holder\/third-party provider has selected the related SCA routine.<\/li><li><strong>started<\/strong>: The addressed SCA routine has been started.<\/li><li><strong>finalised<\/strong>: The SCA routine has been finalized successfully (including a potential confirmation command). This is a final status of the authorization resource.<\/li><li><strong>failed<\/strong>: The SCA routine failed. This is a final status of the authorization resource.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"scaStatus\\\": \\\"finalised\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/business-accounts\/aisp\"\n                        target=\"_self\"\n                        >\n                    Get account holder information\n                <\/a><\/li><li><a href=\"\/business-accounts\/piisp\"\n                        target=\"_self\"\n                        >\n                    Confirm funds\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/pisp","articleFields":{"description":"Learn how to consume our dedicated PISP endpoints.","feedback_component":true,"id":"31504141","type":"page","_expandable":{"operations":""},"status":"current","parameters":{"directoryPath":"\/business-accounts","model":"balance platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/pisp","title":"Initiate payments on behalf of account holders","content":"As part of the open banking framework for Payment Initiation Service Providers (PISPs), Adyen provides endpoints to initiate payment transactions on behalf of account holders who have given their consent.\nThis page explains how you, as a third-party PISP, use the \/payments endpoint to:\n\nInitiate a payment\nGet the status of a payment\nGet the status of a payment authorization\n\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nNot applicable; this documentation is intended for third-party providers.\n\n\nSetup steps\nBefore you begin, you must: Complete the Adyen onboarding steps. Have your access token for the Adyen business account.\n\n\n\nInitiate a payment\nTo initiate a single payment on behalf of your account holder:\n\n\nMake a POST \/payments\/target-2-payments request with the following parameters in the request body. The request header includes, for example, an IPv4 address like 19.68.26.143, or an IPv6 address like 2001:db8:1:1:1:1:1:1.\n\n\n\nParameter\nRequired\nDescription\n\n\n\n\ninstructedAmount\n\nThe currency and the amount of the payment.\n\n\ncreditorAccount\n\nThe account number of the creditor\u2014the person or entity who will receive the payment.\n\n\ndebtorAccount\n\nThe account number of the debtor.\n\n\ncreditorName\n\nThe name of the creditor.\n\n\ncreditorAddress\n\nThe address of the creditor.\n\n\n\nHere is an example of a request to initiate a payment of EUR&nbsp;0.50 to Railway Company.\n\n\n\n\n\nThe response contains the details of the initiated payment, including the transactionStatus and the paymentId. The response contains the following fields:\n\n\n\nParameter\nDescription\n\n\n\n\ntransactionStatus\nCurrent status of the payment. Possible values: ACCP: Accepted customer profile.ACFC: Accepted funds checked.ACCC: Accepted settlement completed on the creditor's account.ACSC: Accepted settlement completed on the debtor's account.ACSP: Accepted settlement in process.ACTC: Accepted technical validation.ACWC: Accepted with change.ACWP: Accepted without posting.CANC: Payment initiation has been cancelled before execution.RCVD: Payment initiation has been received. RJCT: Payment initiation or individual transaction included in the payment initiation has been rejected. PDNG: Payment initiation or individual transaction included in the payment initiation is pending.PART: Partially accepted.PATC: Partially accepted technical.\n\n\n\npaymentId\nA list of characters that represents the ID of a specific payment.\n\n\n\n\n\n\n\n\n\nGet payment status\nTo get the status of the payment:\n\n\nMake a GET \/payments\/target-2-payments\/{paymentId} request. Use this endpoint to check if the payment has been confirmed. The paymentId is found in the response of the Initiate a payment step.  Keep polling the endpoint for status updates (recommended every 5 seconds).\n\n\n\n\n\nThe response contains the transactionStatus which describes the current state of the payment. The response may look like this:\n\n\n\n\n\nGet authorization status\nTo get information about the payment authorization details and determine where your account holder is in the in authorization flow to initiate payments.\n\n\nMake a GET \/payments\/target-2-payments\/{paymentId}\/authorisations\/{authorizationId} request, where paymentId represents a unique identifier for a payment transaction and authorizationId is a unique identifier for a specific payment authorization.\n\n\n\n\n\nThe response contains the authorization status. See the scaStatus for all possible values.\n\n\n\nParameter\nDescription\n\n\n\n\nscaStatus\nStatus of authorization. Possible values: scaMethodSelected: The account holder\/third-party provider has selected the related SCA routine.started: The addressed SCA routine has been started.finalised: The SCA routine has been finalized successfully (including a potential confirmation command). This is a final status of the authorization resource.failed: The SCA routine failed. This is a final status of the authorization resource.\n\n\n\n\n\n\n\n\nSee also\n\n\n                    Get account holder information\n                \n                    Confirm funds\n                \n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Business accounts","lvl2":"Initiate payments on behalf of account holders"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/business-accounts","lvl2":"\/pt\/business-accounts\/pisp"},"levels":3,"category":"","category_color":"","tags":["Initiate","payments","behalf","account","holders"]}}